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

Class PeopleOrganizerResource

java.lang.Object
org.odpi.openmetadata.viewservices.peopleorganizer.server.spring.PeopleOrganizerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/people-organizer") public class PeopleOrganizerResource extends Object
The PeopleOrganizerResource provides part of the server-side implementation of the People Organizer OMVS. =

  • Constructor Details

    • PeopleOrganizerResource

      public PeopleOrganizerResource()
      Default constructor

  • Method Details

    • linkPeerPerson

      @PostMapping(path="/actor-profiles/{personOneGUID}/peer-persons/{personTwoGUID}/attach") public VoidResponse linkPeerPerson(@PathVariable String serverName, @PathVariable String personOneGUID, @PathVariable String personTwoGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a person profile to one of its peers.
      Parameters:
      serverName - name of called server
      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 personOneGUID, @PathVariable String personTwoGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach a person profile from one of its peers.
      Parameters:
      serverName - name of called server
      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 superTeamGUID, @PathVariable String subteamGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a super team to a subteam.
      Parameters:
      serverName - name of called server
      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 superTeamGUID, @PathVariable String subteamGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach a super team from a subteam.
      Parameters:
      serverName - name of called server
      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.