Package org.odpi.openmetadata.viewservices.actormanager.server

Class ActorManagerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.actormanager.server.ActorManagerRESTServices
public class ActorManagerRESTServices extends TokenController
The ActorManagerRESTServices provides the server-side implementation of the Actor Manager Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • ActorManagerRESTServices

      public ActorManagerRESTServices()
      Default constructor

  • Method Details

    • createActorProfile

      public GUIDResponse createActorProfile(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create an actor profile.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the actor profile.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createActorProfileFromTemplate

      public GUIDResponse createActorProfileFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent an actor profile using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateActorProfile

      public BooleanResponse updateActorProfile(String serverName, String urlMarker, String actorProfileGUID, UpdateElementRequestBody requestBody)
      Update the properties of an actor profile.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      actorProfileGUID - unique identifier of the actor profile (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkAssetToProfile

      public VoidResponse linkAssetToProfile(String serverName, String urlMarker, String assetGUID, String itProfileGUID, NewRelationshipRequestBody requestBody)
      Attach an asset to an IT profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachAssetFromProfile

      public VoidResponse detachAssetFromProfile(String serverName, String urlMarker, String assetGUID, String itProfileGUID, DeleteRelationshipRequestBody requestBody)
      Detach an asset from an IT profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteActorProfile

      public VoidResponse deleteActorProfile(String serverName, String urlMarker, String actorProfileGUID, DeleteElementRequestBody requestBody)
      Delete an actor profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      actorProfileGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getActorProfilesByName

      public OpenMetadataRootElementsResponse getActorProfilesByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of actor profile metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getActorProfileByGUID

      public OpenMetadataRootElementResponse getActorProfileByGUID(String serverName, String urlMarker, String actorProfileGUID, GetRequestBody requestBody)
      Retrieve the list of actor profile metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      actorProfileGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findActorProfiles

      public OpenMetadataRootElementsResponse findActorProfiles(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of actor profile metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createContributionRecord

      public GUIDResponse createContributionRecord(String serverName, String urlMarker, String elementGUID, NewAttachmentRequestBody requestBody)
      Creates a new contribution record and returns the unique identifier for it.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element where the contribution record is located
      requestBody - contains the name of the tag and (optional) description of the tag
      Returns:
      guid for new tag or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateContributionRecord

      public VoidResponse updateContributionRecord(String serverName, String urlMarker, String contributionRecordGUID, UpdateElementRequestBody requestBody)
      Update an existing contribution record.
      Parameters:
      serverName - name of the server instances for this request.
      contributionRecordGUID - unique identifier for the contribution record to change.
      urlMarker - view service URL marker
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteContributionRecord

      public VoidResponse deleteContributionRecord(String serverName, String urlMarker, String contributionRecordGUID, DeleteElementRequestBody requestBody)
      Removes a contribution record from the repository. All the relationships to referenceables are lost.
      Parameters:
      serverName - name of the server instances for this request
      contributionRecordGUID - unique id for the contribution record.
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findContributionRecords

      public OpenMetadataRootElementsResponse findContributionRecords(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of contribution record metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getContributionRecordsByName

      public OpenMetadataRootElementsResponse getContributionRecordsByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of contribution record metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      requestBody - name to search for and correlators
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getContributionRecordByGUID

      public OpenMetadataRootElementResponse getContributionRecordByGUID(String serverName, String urlMarker, String contributionRecordGUID, GetRequestBody requestBody)
      Retrieve the contribution record metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      contributionRecordGUID - unique identifier of the requested metadata element
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createActorRole

      public GUIDResponse createActorRole(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create an actor role.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the actor role.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createActorRoleFromTemplate

      public GUIDResponse createActorRoleFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent an actor role using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateActorRole

      public BooleanResponse updateActorRole(String serverName, String urlMarker, String actorRoleGUID, UpdateElementRequestBody requestBody)
      Update the properties of an actor role.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      actorRoleGUID - unique identifier of the actor role (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkPersonRoleToProfile

      public VoidResponse linkPersonRoleToProfile(String serverName, String urlMarker, String personRoleGUID, String personProfileGUID, NewRelationshipRequestBody requestBody)
      Attach a team role to a team profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      personRoleGUID - unique identifier of the person role
      personProfileGUID - unique identifier of the person profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachPersonRoleFromProfile

      public VoidResponse detachPersonRoleFromProfile(String serverName, String urlMarker, String personRoleGUID, String personProfileGUID, DeleteRelationshipRequestBody requestBody)
      Detach a team role from a team profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      personRoleGUID - unique identifier of the person role
      personProfileGUID - unique identifier of the person profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamRoleToProfile

      public VoidResponse linkTeamRoleToProfile(String serverName, String urlMarker, String teamRoleGUID, String teamProfileGUID, NewRelationshipRequestBody requestBody)
      Attach a team role to a team profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      teamRoleGUID - unique identifier of the team role
      teamProfileGUID - unique identifier of the team profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamRoleFromProfile

      public VoidResponse detachTeamRoleFromProfile(String serverName, String urlMarker, String teamRoleGUID, String teamProfileGUID, DeleteRelationshipRequestBody requestBody)
      Detach a team role from a team profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      teamRoleGUID - unique identifier of the team role
      teamProfileGUID - unique identifier of the team profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkITProfileRoleToProfile

      public VoidResponse linkITProfileRoleToProfile(String serverName, String urlMarker, String itProfileRoleGUID, String itProfileGUID, NewRelationshipRequestBody requestBody)
      Attach an IT profile role to an IT profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      itProfileRoleGUID - unique identifier of the IT profile role
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachITProfileRoleFromProfile

      public VoidResponse detachITProfileRoleFromProfile(String serverName, String urlMarker, String itProfileRoleGUID, String itProfileGUID, DeleteRelationshipRequestBody requestBody)
      Detach an IT profile role from an IT profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      itProfileRoleGUID - unique identifier of the IT profile role
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteActorRole

      public VoidResponse deleteActorRole(String serverName, String urlMarker, String actorRoleGUID, DeleteElementRequestBody requestBody)
      Delete an actor role.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      actorRoleGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getActorRolesByName

      public OpenMetadataRootElementsResponse getActorRolesByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of actor role metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getActorRoleByGUID

      public OpenMetadataRootElementResponse getActorRoleByGUID(String serverName, String urlMarker, String actorRoleGUID, GetRequestBody requestBody)
      Retrieve the list of actor role metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      actorRoleGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findActorRoles

      public OpenMetadataRootElementsResponse findActorRoles(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of actor role metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createUserIdentity

      public GUIDResponse createUserIdentity(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create a user identity.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the user identity.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createUserIdentityFromTemplate

      public GUIDResponse createUserIdentityFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a user identity using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateUserIdentity

      public BooleanResponse updateUserIdentity(String serverName, String urlMarker, String userIdentityGUID, UpdateElementRequestBody requestBody)
      Update the properties of a user identity.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the user identity (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkIdentityToProfile

      public VoidResponse linkIdentityToProfile(String serverName, String urlMarker, String userIdentityGUID, String profileGUID, NewRelationshipRequestBody requestBody)
      Attach a profile to a user identity.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the parent
      profileGUID - unique identifier of the actor profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachProfileIdentity

      public VoidResponse detachProfileIdentity(String serverName, String urlMarker, String userIdentityGUID, String profileGUID, DeleteRelationshipRequestBody requestBody)
      Detach an actor profile from a user identity.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the parent actor profile
      profileGUID - unique identifier of the nested actor profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addSecurityGroupMembership

      public VoidResponse addSecurityGroupMembership(String serverName, String urlMarker, String userIdentityGUID, NewClassificationRequestBody requestBody)
      Add the SecurityGroupMembership classification to the user identity.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the user identity
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • updateSecurityGroupMembership

      public VoidResponse updateSecurityGroupMembership(String serverName, String urlMarker, String userIdentityGUID, UpdateClassificationRequestBody requestBody)
      Update the SecurityGroupMembership classification to the user identity.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the user identity
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • removeAllSecurityGroupMembership

      public VoidResponse removeAllSecurityGroupMembership(String serverName, String urlMarker, String userIdentityGUID, MetadataSourceRequestBody requestBody)
      Detach a user identity from a supporting user identity.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the first user identity
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteUserIdentity

      public VoidResponse deleteUserIdentity(String serverName, String urlMarker, String userIdentityGUID, DeleteElementRequestBody requestBody)
      Delete a user identity.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getUserIdentitiesByName

      public OpenMetadataRootElementsResponse getUserIdentitiesByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of user identity metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getUserIdentityByGUID

      public OpenMetadataRootElementResponse getUserIdentityByGUID(String serverName, String urlMarker, String userIdentityGUID, GetRequestBody requestBody)
      Retrieve the list of user identity metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findUserIdentities

      public OpenMetadataRootElementsResponse findUserIdentities(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of user identity metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • linkAssignmentScope

      public VoidResponse linkAssignmentScope(String serverName, String urlMarker, String scopeElementGUID, String actorGUID, NewRelationshipRequestBody requestBody)
      Attach an actor to an element such as a team, project, community, that defines its scope.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      scopeElementGUID - unique identifier of the element
      actorGUID - unique identifier of the actor
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachAssignmentScope

      public VoidResponse detachAssignmentScope(String serverName, String urlMarker, String scopeElementGUID, String actorGUID, DeleteRelationshipRequestBody requestBody)
      Detach an actor from its scope.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      scopeElementGUID - unique identifier of the element
      actorGUID - unique identifier of the actor
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createContactDetails

      public GUIDResponse createContactDetails(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create contact details for a profile.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the contact details.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createContactDetailsFromTemplate

      public GUIDResponse createContactDetailsFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a contact details using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateContactDetails

      public BooleanResponse updateContactDetails(String serverName, String urlMarker, String contactDetailsGUID, UpdateElementRequestBody requestBody)
      Update the properties of a contact details.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      contactDetailsGUID - unique identifier of the contact details (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkContactDetails

      public VoidResponse linkContactDetails(String serverName, String urlMarker, String elementGUID, String contactDetailsGUID, NewRelationshipRequestBody requestBody)
      Attach an element to its contact details.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the parent element.
      contactDetailsGUID - unique identifier of the nested data field.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachContactDetails

      public VoidResponse detachContactDetails(String serverName, String urlMarker, String elementGUID, String contactDetailsGUID, DeleteRelationshipRequestBody requestBody)
      Detach an element from its contact details.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the parent element
      contactDetailsGUID - unique identifier of the contact details
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteContactDetails

      public VoidResponse deleteContactDetails(String serverName, String urlMarker, String contactDetailsGUID, DeleteElementRequestBody requestBody)
      Delete a contact details.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contactDetailsGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getContactDetailsByName

      public OpenMetadataRootElementsResponse getContactDetailsByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of contact details metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getContactDetailsByGUID

      public OpenMetadataRootElementResponse getContactDetailsByGUID(String serverName, String urlMarker, String contactDetailsGUID, GetRequestBody requestBody)
      Retrieve the list of contact details metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      contactDetailsGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findContactDetails

      public OpenMetadataRootElementsResponse findContactDetails(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of contact details metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)