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

Class ActorManagerResource

java.lang.Object
org.odpi.openmetadata.viewservices.actormanager.server.spring.ActorManagerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}") public class ActorManagerResource extends Object
The ActorManagerResource provides part of the server-side implementation of the Actor Manager OMVS. =

  • Constructor Details

    • ActorManagerResource

      public ActorManagerResource()
      Default constructor

  • Method Details

    • createActorProfile

      @PostMapping(path="/actor-profiles") public GUIDResponse createActorProfile(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create a 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

      @PostMapping(path="/actor-profiles/from-template") public GUIDResponse createActorProfileFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent a 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

      @PostMapping(path="/actor-profiles/{actorProfileGUID}/update") public VoidResponse updateActorProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorProfileGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a actor profile.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      actorProfileGUID - unique identifier of the actor profile (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      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.

    • linkLocationToProfile

      @PostMapping(path="/actor-profiles/{actorProfileGUID}/profile-locations/{locationGUID}/attach") public VoidResponse linkLocationToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorProfileGUID, @PathVariable String locationGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Attach a profile to a location.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      locationGUID - unique identifier of the location
      actorProfileGUID - 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.

    • detachLocationFromProfile

      @PostMapping(path="/actor-profiles/{actorProfileGUID}/profile-locations/{locationGUID}/detach") public VoidResponse detachLocationFromProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorProfileGUID, @PathVariable String locationGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Detach an actor profile from a location.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      actorProfileGUID - unique identifier of the actor profile
      locationGUID - unique identifier of the location
      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.

    • linkPeerPerson

      @PostMapping(path="/actor-profiles/{personOneGUID}/peer-persons/{personTwoGUID}/attach") public VoidResponse linkPeerPerson(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String personOneGUID, @PathVariable String personTwoGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Attach a person profile to one of its peers.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      personOneGUID - unique identifier of the first person profile
      personTwoGUID - unique identifier of the second 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.

    • detachPeerPerson

      @PostMapping(path="/actor-profiles/{personOneGUID}/peer-persons/{personTwoGUID}/detach") public VoidResponse detachPeerPerson(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String personOneGUID, @PathVariable String personTwoGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Detach a person profile from one of its peers.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      personOneGUID - unique identifier of the first person profile
      personTwoGUID - unique identifier of the second 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.

    • linkTeamStructure

      @PostMapping(path="/actor-profiles/{superTeamGUID}/team-structures/{subteamGUID}/attach") public VoidResponse linkTeamStructure(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String superTeamGUID, @PathVariable String subteamGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Attach a super team to a subteam.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      superTeamGUID - unique identifier of the super team
      subteamGUID - unique identifier of the subteam
      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.

    • detachTeamStructure

      @PostMapping(path="/actor-profiles/{superTeamGUID}/team-structures/{subteamGUID}/detach") public VoidResponse detachTeamStructure(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String superTeamGUID, @PathVariable String subteamGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Detach a super team from a subteam.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      superTeamGUID - unique identifier of the super team
      subteamGUID - unique identifier of the subteam
      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.

    • linkAssetToProfile

      @PostMapping(path="/assets/{assetGUID}/it-profiles/{itProfileGUID}/attach") public VoidResponse linkAssetToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String itProfileGUID, @RequestBody(required=false) RelationshipRequestBody 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

      @PostMapping(path="/assets/{assetGUID}/it-profiles/{itProfileGUID}/detach") public VoidResponse detachAssetFromProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String itProfileGUID, @RequestBody(required=false) MetadataSourceRequestBody 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.

    • linkTeamToMembershipRole

      @PostMapping(path="/actor-profiles/{teamGUID}/team-membership-roles/{personRoleGUID}/attach") public VoidResponse linkTeamToMembershipRole(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String teamGUID, @PathVariable String personRoleGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Attach a team to its membership role.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      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.

    • detachTeamFromMembershipRole

      @PostMapping(path="/actor-profiles/{teamGUID}/team-membership-roles/{personRoleGUID}/detach") public VoidResponse detachTeamFromMembershipRole(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String teamGUID, @PathVariable String personRoleGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Detach a team profile from its membership role.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      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.

    • linkTeamToLeadershipRole

      @PostMapping(path="/actor-profiles/{teamGUID}/team-leadership-roles/{personRoleGUID}/attach") public VoidResponse linkTeamToLeadershipRole(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String teamGUID, @PathVariable String personRoleGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Attach a team to its leadership role.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      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.

    • detachTeamFromLeadershipRole

      @PostMapping(path="/actor-profiles/{teamGUID}/team-leadership-roles/{personRoleGUID}/detach") public VoidResponse detachTeamFromLeadershipRole(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String teamGUID, @PathVariable String personRoleGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Detach a team profile from its leadership role.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      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

      @PostMapping(path="/actor-profiles/{actorProfileGUID}/delete") public VoidResponse deleteActorProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorProfileGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Delete a actor profile.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      actorProfileGUID - unique identifier of the element to delete
      cascadedDelete - can actor profiles be deleted if data fields are attached?
      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

      @PostMapping(path="/actor-profiles/by-name") public ActorProfilesResponse getActorProfilesByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of actor profiles with a particular name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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

      @PostMapping(path="/actor-profiles/by-search-string") public ActorProfilesResponse findActorProfiles(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) 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
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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

      @PostMapping(path="/actor-profiles/{actorProfileGUID}/retrieve") public ActorProfileResponse getActorProfileByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorProfileGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody)
      Return the properties of a specific actor profile.
      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)

    • createActorRole

      @PostMapping(path={"/actor-roles","/solution-roles"}) public GUIDResponse createActorRole(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create a 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

      @PostMapping(path={"/actor-roles/from-template","/solution-roles/from-template"}) public GUIDResponse createActorRoleFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent a 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

      @PostMapping(path={"/actor-roles/{actorRoleGUID}/update","/solution-roles/{actorRoleGUID}/update"}) public VoidResponse updateActorRole(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorRoleGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a actor role.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      actorRoleGUID - unique identifier of the actor role (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      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

      @PostMapping(path="/actor-roles/{personRoleGUID}/person-role-appointments/{personProfileGUID}/attach") public VoidResponse linkPersonRoleToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String personRoleGUID, @PathVariable String personProfileGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Attach a person role to a person 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

      @PostMapping(path="/actor-roles/{personRoleGUID}/person-role-appointments/{personProfileGUID}/detach") public VoidResponse detachPersonRoleFromProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String personRoleGUID, @PathVariable String personProfileGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Detach a person role from a 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

      @PostMapping(path="/actor-roles/{teamRoleGUID}/team-role-appointments/{teamProfileGUID}/attach") public VoidResponse linkTeamRoleToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String teamRoleGUID, @PathVariable String teamProfileGUID, @RequestBody(required=false) RelationshipRequestBody 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

      @PostMapping(path="/actor-roles/{teamRoleGUID}/team-role-appointments/{teamProfileGUID}/detach") public VoidResponse detachTeamRoleFromProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String teamRoleGUID, @PathVariable String teamProfileGUID, @RequestBody(required=false) MetadataSourceRequestBody 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

      @PostMapping(path="/actor-roles/{itProfileRoleGUID}/it-profile-role-appointments/{itProfileGUID}/attach") public VoidResponse linkITProfileRoleToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String itProfileRoleGUID, @PathVariable String itProfileGUID, @RequestBody(required=false) RelationshipRequestBody 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

      @PostMapping(path="/actor-roles/{itProfileRoleGUID}/it-profile-role-appointments/{itProfileGUID}/detach") public VoidResponse detachITProfileRoleFromProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String itProfileRoleGUID, @PathVariable String itProfileGUID, @RequestBody(required=false) MetadataSourceRequestBody 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

      @PostMapping(path={"/actor-roles/{actorRoleGUID}/delete","/solution-roles/{actorRoleGUID}/delete"}) public VoidResponse deleteActorRole(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorRoleGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Delete a actor role.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      actorRoleGUID - unique identifier of the element to delete
      cascadedDelete - can actor roles be deleted if data fields are attached?
      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

      @PostMapping(path={"/actor-roles/by-name","/solution-roles/by-name"}) public ActorRolesResponse getActorRolesByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of actor roles with a particular name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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

      @PostMapping(path={"/actor-roles/by-search-string","/solution-roles/by-search-string"}) public ActorRolesResponse findActorRoles(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) 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
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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

      @PostMapping(path={"/actor-roles/{actorRoleGUID}/retrieve","/solution-roles/{actorRoleGUID}/retrieve"}) public ActorRoleResponse getActorRoleByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorRoleGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody)
      Return the properties of a specific actor role.
      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)

    • createUserIdentity

      @PostMapping(path="/user-identities") public GUIDResponse createUserIdentity(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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

      @PostMapping(path="/user-identities/from-template") public GUIDResponse createUserIdentityFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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

      @PostMapping(path="/user-identities/{userIdentityGUID}/update") public VoidResponse updateUserIdentity(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String userIdentityGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) 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)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      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

      @PostMapping(path="/user-identities/{userIdentityGUID}/profile-identity/{profileGUID}/attach") public VoidResponse linkIdentityToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String userIdentityGUID, @PathVariable String profileGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Attach a profile to a user identity.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the user identity
      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

      @PostMapping(path="/user-identities/{userIdentityGUID}/profile-identity/{profileGUID}/detach") public VoidResponse detachProfileIdentity(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String userIdentityGUID, @PathVariable String profileGUID, @RequestBody(required=false) MetadataSourceRequestBody 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 user identity
      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.

    • addSecurityGroupMembership

      @PostMapping(path="/user-identities/{userIdentityGUID}/security-group-memberships/classify") public VoidResponse addSecurityGroupMembership(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String userIdentityGUID, @RequestBody(required=false) ClassificationRequestBody 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.

    • removeAllSecurityGroupMembership

      @PostMapping(path="/user-identities/{userIdentityGUID}/security-group-memberships/declassify") public VoidResponse removeAllSecurityGroupMembership(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String userIdentityGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Remove the SecurityGroupMembership classification from 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.

    • deleteUserIdentity

      @PostMapping(path="/user-identities/{userIdentityGUID}/delete") public VoidResponse deleteUserIdentity(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String userIdentityGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Delete a user identity.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      userIdentityGUID - unique identifier of the element to delete
      cascadedDelete - can user identities be deleted if data fields are attached?
      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

      @PostMapping(path="/user-identities/by-name") public UserIdentitiesResponse getUserIdentitiesByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of user identities with a particular name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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

      @PostMapping(path="/user-identities/by-search-string") public UserIdentitiesResponse findUserIdentities(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) 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
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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

      @PostMapping(path="/user-identities/{userIdentityGUID}/retrieve") public UserIdentityResponse getUserIdentityByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String userIdentityGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody)
      Return the properties of a specific user identity.
      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)