Package org.odpi.openmetadata.accessservices.communityprofile.server.spring

Class RelatedElementsResource

java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.server.spring.RelatedElementsResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/community-profile/users/{userId}") public class RelatedElementsResource extends Object
The RelatedElementsResource provides a Spring based server-side REST API that supports the RelatedElementsManagementInterface. It delegates each request to the RelatedElementRESTServices. This provides the server-side implementation of the Community Profile Open Metadata Assess Service (OMAS) which is used to manage information about people, roles and organizations.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RelatedElementsResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAssignmentScope(String serverName, String userId, String elementGUID, String scopeGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
    Remove an "AssignmentScope" relationship between two referenceables.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearMoreInformation(String serverName, String userId, String elementGUID, String detailGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
    Remove a "MoreInformation" relationship between two referenceables.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearResource(String serverName, String userId, String elementGUID, String resourceGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
    Remove a "ResourceList" relationship between two referenceables.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearStakeholder(String serverName, String userId, String elementGUID, String stakeholderGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
    Remove a "Stakeholder" relationship between two referenceables.
    org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse
    getAssignedActors(String serverName, String userId, String scopeGUID, int startFrom, int pageSize)
    Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.
    org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse
    getAssignedScopes(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
    Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.
    org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse
    getDescriptiveElements(String serverName, String userId, String detailGUID, int startFrom, int pageSize)
    Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
    org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse
    getMoreInformation(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
    Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
    org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse
    getResourceList(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
    Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
    org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse
    getStakeholderCommissionedElements(String serverName, String userId, String stakeholderGUID, int startFrom, int pageSize)
    Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.
    org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse
    getStakeholders(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
    Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.
    org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse
    getSupportedByResource(String serverName, String userId, String resourceGUID, int startFrom, int pageSize)
    Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupAssignmentScope(String serverName, String userId, String elementGUID, String scopeGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
    Create an "AssignmentScope" relationship between an element and its scope.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupMoreInformation(String serverName, String userId, String elementGUID, String detailGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
    Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupResource(String serverName, String userId, String elementGUID, String resourceGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
    Create a "ResourceList" relationship between a consuming element and an element that represents resources.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupStakeholder(String serverName, String userId, String elementGUID, String stakeholderGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
    Create a "Stakeholder" relationship between an element and its stakeholder.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • RelatedElementsResource

      public RelatedElementsResource()
      Default constructor

  • Method Details

    • setupMoreInformation

      @PostMapping(path="/related-elements/{elementGUID}/more-information/{detailGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupMoreInformation(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String detailGUID, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
      Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element that is descriptive
      detailGUID - unique identifier of the element that provides the detail
      requestBody - relationship properties
      Returns:
      void 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)

    • clearMoreInformation

      @PostMapping(path="/related-elements/{elementGUID}/more-information/{detailGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearMoreInformation(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String detailGUID, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
      Remove a "MoreInformation" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element that is descriptive
      detailGUID - unique identifier of the element that provides the detail
      requestBody - external source identifiers
      Returns:
      void 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)

    • getMoreInformation

      @GetMapping(path="/related-elements/more-information/by-descriptive-element/{elementGUID}") public org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse getMoreInformation(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element that is descriptive
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      void 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)

    • getDescriptiveElements

      @GetMapping(path="/related-elements/more-information/by-detail-element/{detailGUID}") public org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse getDescriptiveElements(@PathVariable String serverName, @PathVariable String userId, @PathVariable String detailGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      detailGUID - unique identifier of the element that provides the detail
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      void 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)

    • setupStakeholder

      @PostMapping(path="/related-elements/{elementGUID}/stakeholders/{stakeholderGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupStakeholder(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String stakeholderGUID, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
      Create a "Stakeholder" relationship between an element and its stakeholder.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      stakeholderGUID - unique identifier of the stakeholder
      requestBody - relationship properties
      Returns:
      void 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)

    • clearStakeholder

      @PostMapping(path="/related-elements/{elementGUID}/stakeholders/{stakeholderGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearStakeholder(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String stakeholderGUID, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
      Remove a "Stakeholder" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      stakeholderGUID - unique identifier of the stakeholder
      requestBody - external source identifiers
      Returns:
      void 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)

    • getStakeholders

      @GetMapping(path="/related-elements/stakeholders/by-commissioned-element/{elementGUID}") public org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse getStakeholders(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      void 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)

    • getStakeholderCommissionedElements

      @GetMapping(path="/related-elements/stakeholders/by-stakeholder/{stakeholderGUID}") public org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse getStakeholderCommissionedElements(@PathVariable String serverName, @PathVariable String userId, @PathVariable String stakeholderGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      stakeholderGUID - unique identifier of the stakeholder
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      void 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)

    • setupAssignmentScope

      @PostMapping(path="/related-elements/{elementGUID}/assignment-scopes/{scopeGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupAssignmentScope(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String scopeGUID, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
      Create an "AssignmentScope" relationship between an element and its scope.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      scopeGUID - unique identifier of the scope
      requestBody - relationship properties
      Returns:
      void 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)

    • clearAssignmentScope

      @PostMapping(path="/related-elements/{elementGUID}/assignment-scopes/{scopeGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAssignmentScope(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String scopeGUID, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
      Remove an "AssignmentScope" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      scopeGUID - unique identifier of the scope
      requestBody - external source identifiers
      Returns:
      void 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)

    • getAssignedScopes

      @GetMapping(path="/related-elements/assignment-scopes/by-assigned-actor/{elementGUID}") public org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse getAssignedScopes(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      void 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)

    • getAssignedActors

      @GetMapping(path="/related-elements/assignment-scopes/by-assigned-scope/{scopeGUID}") public org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse getAssignedActors(@PathVariable String serverName, @PathVariable String userId, @PathVariable String scopeGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      scopeGUID - unique identifier of the scope
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      void 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)

    • setupResource

      @PostMapping(path="/related-elements/{elementGUID}/resource-list/{resourceGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupResource(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String resourceGUID, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
      Create a "ResourceList" relationship between a consuming element and an element that represents resources.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      resourceGUID - unique identifier of the resource
      requestBody - relationship properties
      Returns:
      void 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)

    • clearResource

      @PostMapping(path="/related-elements/{elementGUID}/resource-list/{resourceGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearResource(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String resourceGUID, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
      Remove a "ResourceList" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      resourceGUID - unique identifier of the resource
      requestBody - external source identifiers
      Returns:
      void 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)

    • getResourceList

      @GetMapping(path="/related-elements/resource-list/by-assignee/{elementGUID}") public org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse getResourceList(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      void 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)

    • getSupportedByResource

      @GetMapping(path="/related-elements/resource-list/by-resource/{resourceGUID}") public org.odpi.openmetadata.accessservices.communityprofile.rest.RelatedElementListResponse getSupportedByResource(@PathVariable String serverName, @PathVariable String userId, @PathVariable String resourceGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      resourceGUID - unique identifier of the resource
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      void 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)