Package org.odpi.openmetadata.accessservices.projectmanagement.server

Class ProjectManagementRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.projectmanagement.server.ProjectManagementRESTServices
public class ProjectManagementRESTServices extends Object
The ProjectManagementRESTServices provides the server-side implementation of the Stewardship Action Open Metadata Assess Service (OMAS). This interface provides connections to assets and APIs for adding feedback on the asset.

  • Constructor Details

    • ProjectManagementRESTServices

      public ProjectManagementRESTServices()
      Default constructor

  • Method Details

    • createProject

      public GUIDResponse createProject(String serverName, String userId, ReferenceableRequestBody requestBody)
      Create a new metadata element to represent a project.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateProject

      public VoidResponse updateProject(String serverName, String userId, String projectGUID, boolean isMergeUpdate, ReferenceableRequestBody requestBody)
      Update the metadata element representing a project.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      projectGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with the existing properties of overlay them?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupProjectTeam

      public VoidResponse setupProjectTeam(String serverName, String userId, String projectGUID, String projectRoleGUID, RelationshipRequestBody requestBody)
      Create a ProjectTeam relationship between a project and an actor profile (typically a team).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      projectGUID - unique identifier of the project
      projectRoleGUID - unique identifier of the actor
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearProjectTeam

      public VoidResponse clearProjectTeam(String serverName, String userId, String projectGUID, String actorProfileGUID, ExternalSourceRequestBody requestBody)
      Remove a ProjectTeam relationship between a project and an actor profile (typically a team).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      projectGUID - unique identifier of the project
      actorProfileGUID - unique identifier of the actor
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupProjectManagementRole

      public VoidResponse setupProjectManagementRole(String serverName, String userId, String projectGUID, String projectRoleGUID, RelationshipRequestBody requestBody)
      Create a relationship between a project and a person role.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      projectGUID - unique identifier of the project
      projectRoleGUID - unique identifier of the person role
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearProjectManagementRole

      public VoidResponse clearProjectManagementRole(String serverName, String userId, String projectGUID, String projectRoleGUID, ExternalSourceRequestBody requestBody)
      Remove a relationship between a project and a person role.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      projectGUID - unique identifier of the project
      projectRoleGUID - unique identifier of the person role
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeProject

      public VoidResponse removeProject(String serverName, String userId, String projectGUID, ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a project.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      projectGUID - unique identifier of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findProjects

      public ProjectsResponse findProjects(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of project metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getProjectsByName

      public ProjectsResponse getProjectsByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of project metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getProjectManagementRoles

      public PersonRolesResponse getProjectManagementRoles(String serverName, String userId, String projectGUID, int startFrom, int pageSize)
      Return information about the project management roles linked to a project.
      Parameters:
      serverName - called server
      userId - calling user
      projectGUID - unique identifier for the project
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching person roles InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getProjectActors

      public ActorProfilesResponse getProjectActors(String serverName, String userId, String projectGUID, int startFrom, int pageSize)
      Return information about the actors linked to a project.
      Parameters:
      serverName - called server
      userId - calling user
      projectGUID - unique identifier for the project
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching person roles InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getProjects

      public ProjectsResponse getProjects(String serverName, String userId, int startFrom, int pageSize)
      Retrieve the list of project metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getProjectByGUID

      public ProjectResponse getProjectByGUID(String serverName, String userId, String guid)
      Retrieve the project metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • 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)

    • 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)