Class ActorManagerRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.actormanager.server.ActorManagerRESTServices
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddSecurityGroupMembership
(String serverName, String urlMarker, String userIdentityGUID, NewClassificationRequestBody requestBody) Add the SecurityGroupMembership classification to the user identity.createActorProfile
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create an actor profile.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.createActorRole
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create an actor role.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.createUserIdentity
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create a user identity.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.deleteActorProfile
(String serverName, String urlMarker, String actorProfileGUID, DeleteRequestBody requestBody) Delete an actor profile.deleteActorRole
(String serverName, String urlMarker, String actorRoleGUID, DeleteRequestBody requestBody) Delete an actor role.deleteUserIdentity
(String serverName, String urlMarker, String userIdentityGUID, DeleteRequestBody requestBody) Delete a user identity.detachAssetFromProfile
(String serverName, String urlMarker, String assetGUID, String itProfileGUID, DeleteRequestBody requestBody) Detach an asset from an IT profile.detachAssignmentScope
(String serverName, String urlMarker, String scopeElementGUID, String actorGUID, DeleteRequestBody requestBody) Detach an actor from its scope.detachITProfileRoleFromProfile
(String serverName, String urlMarker, String itProfileRoleGUID, String itProfileGUID, DeleteRequestBody requestBody) Detach an IT profile role from an IT profile.detachPersonRoleFromProfile
(String serverName, String urlMarker, String personRoleGUID, String personProfileGUID, DeleteRequestBody requestBody) Detach a team role from a team profile.detachProfileIdentity
(String serverName, String urlMarker, String userIdentityGUID, String profileGUID, DeleteRequestBody requestBody) Detach an actor profile from a user identity.detachTeamRoleFromProfile
(String serverName, String urlMarker, String teamRoleGUID, String teamProfileGUID, DeleteRequestBody requestBody) Detach a team role from a team profile.findActorProfiles
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Retrieve the list of actor profile metadata elements that contain the search string.findActorRoles
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Retrieve the list of actor role metadata elements that contain the search string.findUserIdentities
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Retrieve the list of user identity metadata elements that contain the search string.getActorProfileByGUID
(String serverName, String urlMarker, String actorProfileGUID, GetRequestBody requestBody) Retrieve the list of actor profile metadata elements that contain the search string.getActorProfilesByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Retrieve the list of actor profile metadata elements that contain the search string.getActorRoleByGUID
(String serverName, String urlMarker, String actorRoleGUID, GetRequestBody requestBody) Retrieve the list of actor role metadata elements that contain the search string.getActorRolesByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Retrieve the list of actor role metadata elements that contain the search string.getUserIdentitiesByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Retrieve the list of user identity metadata elements that contain the search string.getUserIdentityByGUID
(String serverName, String urlMarker, String userIdentityGUID, GetRequestBody requestBody) Retrieve the list of user identity metadata elements that contain the search string.linkAssetToProfile
(String serverName, String urlMarker, String assetGUID, String itProfileGUID, NewRelationshipRequestBody requestBody) Attach an asset to an IT profile.linkAssignmentScope
(String serverName, String urlMarker, String scopeElementGUID, String actorGUID, NewRelationshipRequestBody requestBody) Attach a actor to an element such as a team, project, community, that defines its scope.linkIdentityToProfile
(String serverName, String urlMarker, String userIdentityGUID, String profileGUID, NewRelationshipRequestBody requestBody) Attach a profile to a user identity.linkITProfileRoleToProfile
(String serverName, String urlMarker, String itProfileRoleGUID, String itProfileGUID, NewRelationshipRequestBody requestBody) Attach an IT profile role to an IT profile.linkPersonRoleToProfile
(String serverName, String urlMarker, String personRoleGUID, String personProfileGUID, NewRelationshipRequestBody requestBody) Attach a team role to a team profile.linkTeamRoleToProfile
(String serverName, String urlMarker, String teamRoleGUID, String teamProfileGUID, NewRelationshipRequestBody requestBody) Attach a team role to a team profile.removeAllSecurityGroupMembership
(String serverName, String urlMarker, String userIdentityGUID, MetadataSourceRequestBody requestBody) Detach a user identity from a supporting user identity.updateActorProfile
(String serverName, String urlMarker, String actorProfileGUID, UpdateElementRequestBody requestBody) Update the properties of an actor profile.updateActorRole
(String serverName, String urlMarker, String actorRoleGUID, UpdateElementRequestBody requestBody) Update the properties of an actor role.updateSecurityGroupMembership
(String serverName, String urlMarker, String userIdentityGUID, UpdateClassificationRequestBody requestBody) Update the SecurityGroupMembership classification to the user identity.updateUserIdentity
(String serverName, String urlMarker, String userIdentityGUID, UpdateElementRequestBody requestBody) Update the properties of a user identity.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
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 markerrequestBody
- 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 userurlMarker
- view service URL markerrequestBody
- 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 VoidResponse 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 markeractorProfileGUID
- unique identifier of the actor profile (returned from create)requestBody
- properties for the new element.- Returns:
- void 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 serverurlMarker
- view service URL markerassetGUID
- unique identifier of the assetitProfileGUID
- unique identifier of the IT profilerequestBody
- 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, DeleteRequestBody requestBody) Detach an asset from an IT profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerassetGUID
- unique identifier of the assetitProfileGUID
- unique identifier of the IT profilerequestBody
- 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, DeleteRequestBody requestBody) Delete an actor profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeractorProfileGUID
- unique identifier of the element to deleterequestBody
- 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 tourlMarker
- view service URL markerrequestBody
- 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 tourlMarker
- view service URL markeractorProfileGUID
- unique identifier of the required elementrequestBody
- 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 tourlMarker
- view service URL markerrequestBody
- 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)
-
createActorRole
public GUIDResponse createActorRole(String serverName, String urlMarker, NewElementRequestBody requestBody) Create an actor role.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerrequestBody
- 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 userurlMarker
- view service URL markerrequestBody
- 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 VoidResponse 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 markeractorRoleGUID
- unique identifier of the actor role (returned from create)requestBody
- properties for the new element.- Returns:
- void 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 serverurlMarker
- view service URL markerpersonRoleGUID
- unique identifier of the person rolepersonProfileGUID
- unique identifier of the person profilerequestBody
- 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, DeleteRequestBody requestBody) Detach a team role from a team profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerpersonRoleGUID
- unique identifier of the person rolepersonProfileGUID
- unique identifier of the person profilerequestBody
- 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 serverurlMarker
- view service URL markerteamRoleGUID
- unique identifier of the team roleteamProfileGUID
- unique identifier of the team profilerequestBody
- 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, DeleteRequestBody requestBody) Detach a team role from a team profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerteamRoleGUID
- unique identifier of the team roleteamProfileGUID
- unique identifier of the team profilerequestBody
- 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 serverurlMarker
- view service URL markeritProfileRoleGUID
- unique identifier of the IT profile roleitProfileGUID
- unique identifier of the IT profilerequestBody
- 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, DeleteRequestBody requestBody) Detach an IT profile role from an IT profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeritProfileRoleGUID
- unique identifier of the IT profile roleitProfileGUID
- unique identifier of the IT profilerequestBody
- 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, DeleteRequestBody requestBody) Delete an actor role.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeractorRoleGUID
- unique identifier of the element to deleterequestBody
- 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 tourlMarker
- view service URL markerrequestBody
- 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 tourlMarker
- view service URL markeractorRoleGUID
- unique identifier of the required elementrequestBody
- 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 tourlMarker
- view service URL markerrequestBody
- 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 markerrequestBody
- 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 userurlMarker
- view service URL markerrequestBody
- 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 VoidResponse 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 markeruserIdentityGUID
- unique identifier of the user identity (returned from create)requestBody
- properties for the new element.- Returns:
- void 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 serverurlMarker
- view service URL markeruserIdentityGUID
- unique identifier of the parentprofileGUID
- unique identifier of the actor profilerequestBody
- 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, DeleteRequestBody requestBody) Detach an actor profile from a user identity.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeruserIdentityGUID
- unique identifier of the parent actor profileprofileGUID
- unique identifier of the nested actor profilerequestBody
- 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 serverurlMarker
- view service URL markeruserIdentityGUID
- unique identifier of the user identityrequestBody
- 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 serverurlMarker
- view service URL markeruserIdentityGUID
- unique identifier of the user identityrequestBody
- 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 serverurlMarker
- view service URL markeruserIdentityGUID
- unique identifier of the first user identityrequestBody
- 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, DeleteRequestBody requestBody) Delete a user identity.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeruserIdentityGUID
- unique identifier of the element to deleterequestBody
- 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 tourlMarker
- view service URL markerrequestBody
- 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 tourlMarker
- view service URL markeruserIdentityGUID
- unique identifier of the required elementrequestBody
- 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 tourlMarker
- view service URL markerrequestBody
- 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 a actor to an element such as a team, project, community, that defines its scope.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerscopeElementGUID
- unique identifier of the elementactorGUID
- unique identifier of the actorrequestBody
- 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, DeleteRequestBody requestBody) Detach an actor from its scope.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerscopeElementGUID
- unique identifier of the elementactorGUID
- unique identifier of the actorrequestBody
- 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.
-