Package org.odpi.openmetadata.accessservices.governanceprogram.server

Class RelatedElementRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.governanceprogram.server.RelatedElementRESTServices
public class RelatedElementRESTServices extends Object
RelatedElementRESTServices support requests about common Referenceable relationships. It is the server side for the RelatedElementsManagementInterface.

  • Constructor Details

    • RelatedElementRESTServices

      public RelatedElementRESTServices()

  • Method Details

    • setupMoreInformation

      public VoidResponse setupMoreInformation(String serverName, String userId, String elementGUID, String detailGUID, 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

      public VoidResponse clearMoreInformation(String serverName, String userId, String elementGUID, String detailGUID, 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

      public RelatedElementsResponse getMoreInformation(String serverName, String userId, String elementGUID, int startFrom, 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

      public RelatedElementsResponse getDescriptiveElements(String serverName, String userId, String detailGUID, int startFrom, 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)

    • setupGovernedBy

      public VoidResponse setupGovernedBy(String serverName, String userId, String elementGUID, String governanceDefinitionGUID, RelationshipRequestBody requestBody)
      Create a "GovernedBy" relationship between an element and a governance definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element that is governed
      governanceDefinitionGUID - unique identifier of the governance definition
      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)

    • clearGovernedBy

      public VoidResponse clearGovernedBy(String serverName, String userId, String elementGUID, String governanceDefinitionGUID, ExternalSourceRequestBody requestBody)
      Remove a "GovernedBy" relationship between two elements.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element that is governed
      governanceDefinitionGUID - unique identifier of the governance definition
      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)

    • getGovernanceDefinitionsForElement

      public GovernanceDefinitionsResponse getGovernanceDefinitionsForElement(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
      Retrieve the governance definitions linked via a "GovernedBy" relationship to an element.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element that is governed
      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)

    • getGovernedElements

      public RelatedElementsResponse getGovernedElements(String serverName, String userId, String governanceDefinitionGUID, int startFrom, int pageSize)
      Retrieve the governed elements linked via a "GovernedBy" relationship to a governance definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      governanceDefinitionGUID - 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)

    • setupGovernanceDefinitionScope

      public VoidResponse setupGovernanceDefinitionScope(String serverName, String userId, String governanceDefinitionGUID, String scopeGUID, RelationshipRequestBody requestBody)
      Create an "GovernanceDefinitionScope" relationship between a governance definition and its scope element.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      governanceDefinitionGUID - unique identifier of the governance definition
      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)

    • clearGovernanceDefinitionScope

      public VoidResponse clearGovernanceDefinitionScope(String serverName, String userId, String governanceDefinitionGUID, String scopeGUID, ExternalSourceRequestBody requestBody)
      Remove an "GovernanceDefinitionScope" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      governanceDefinitionGUID - unique identifier of the governance definition
      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)

    • getGovernanceDefinitionScopes

      public RelatedElementsResponse getGovernanceDefinitionScopes(String serverName, String userId, String governanceDefinitionGUID, int startFrom, int pageSize)
      Retrieve the assigned scopes linked by the "GovernanceDefinitionScope" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      governanceDefinitionGUID - unique identifier of the governance definition
      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)

    • getScopedGovernanceDefinitions

      public GovernanceDefinitionsResponse getScopedGovernanceDefinitions(String serverName, String userId, String scopeGUID, int startFrom, int pageSize)
      Retrieve the governance definitions linked by the "GovernanceDefinitionScope" relationship to a scope element.
      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)

    • setupGovernanceResponsibilityAssignment

      public VoidResponse setupGovernanceResponsibilityAssignment(String serverName, String userId, String governanceResponsibilityGUID, String personRoleGUID, RelationshipRequestBody requestBody)
      Create a "GovernanceResponsibilityAssignment" relationship between a governance responsibility and a person role.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      governanceResponsibilityGUID - unique identifier of the governance responsibility (type of governance definition)
      personRoleGUID - unique identifier of the person role element
      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)

    • clearGovernanceResponsibilityAssignment

      public VoidResponse clearGovernanceResponsibilityAssignment(String serverName, String userId, String governanceResponsibilityGUID, String personRoleGUID, ExternalSourceRequestBody requestBody)
      Remove a "GovernanceResponsibilityAssignment" relationship between a governance responsibility and a person role.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      governanceResponsibilityGUID - unique identifier of the governance responsibility (type of governance definition)
      personRoleGUID - unique identifier of the person role element
      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)

    • getResponsibleRoles

      public GovernanceRolesResponse getResponsibleRoles(String serverName, String userId, String governanceResponsibilityGUID, int startFrom, int pageSize)
      Retrieve the person roles linked via a "GovernanceResponsibilityAssignment" relationship to a governance responsibility.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      governanceResponsibilityGUID - unique identifier of the governance responsibility (type of governance definition)
      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)

    • getRoleResponsibilities

      public GovernanceDefinitionsResponse getRoleResponsibilities(String serverName, String userId, String personRoleGUID, int startFrom, int pageSize)
      Retrieve the governance responsibilities linked via a "GovernanceResponsibilityAssignment" relationship to a person role.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      personRoleGUID - unique identifier of the person role 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)

    • setupStakeholder

      public VoidResponse setupStakeholder(String serverName, String userId, String elementGUID, String stakeholderGUID, 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

      public VoidResponse clearStakeholder(String serverName, String userId, String elementGUID, String stakeholderGUID, 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

      public RelatedElementsResponse getStakeholders(String serverName, String userId, String elementGUID, int startFrom, 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

      public RelatedElementsResponse 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.
      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

      public VoidResponse setupAssignmentScope(String serverName, String userId, String elementGUID, String scopeGUID, 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

      public VoidResponse clearAssignmentScope(String serverName, String userId, String elementGUID, String scopeGUID, 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

      public RelatedElementsResponse getAssignedScopes(String serverName, String userId, String elementGUID, int startFrom, 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

      public RelatedElementsResponse getAssignedActors(String serverName, String userId, String scopeGUID, int startFrom, 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

      public VoidResponse setupResource(String serverName, String userId, String elementGUID, String resourceGUID, 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

      public VoidResponse clearResource(String serverName, String userId, String elementGUID, String resourceGUID, 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

      public RelatedElementsResponse 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.
      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

      public RelatedElementsResponse 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.
      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)