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

Class ProjectManagerResource

java.lang.Object
org.odpi.openmetadata.viewservices.projectmanager.server.spring.ProjectManagerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/project-manager") public class ProjectManagerResource extends Object
The ProjectManagerResource provides the Spring API endpoints of the Project Manager Open Metadata View Service (OMVS). =

  • Constructor Details

    • ProjectManagerResource

      public ProjectManagerResource()
      Default constructor

  • Method Details

    • getLinkedProjects

      @PostMapping(path="/metadata-elements/{parentGUID}/projects") public ProjectListResponse getLinkedProjects(@PathVariable String serverName, @PathVariable String parentGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of projects that are linked off of the supplied element. Any relationship will do.
      Parameters:
      serverName - name of called server
      parentGUID - unique identifier of referenceable object (typically a personal profile, project or community) that the projects hang off of
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      requestBody - filter response by project status - if null, any value will do
      Returns:
      a list of projects 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.

    • getClassifiedProjects

      @PostMapping(path="/projects/by-classifications") public ProjectListResponse getClassifiedProjects(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody FilterRequestBody requestBody)
      Returns the list of projects with a particular classification.
      Parameters:
      serverName - name of called server
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      requestBody - name of the classification - if null, all projects are returned
      Returns:
      a list of projects 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.

    • getProjectTeam

      @PostMapping(path="/projects/{projectGUID}/team") public ProjectMemberListResponse getProjectTeam(@PathVariable String serverName, @PathVariable String projectGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of actors that are linked off of the project.
      Parameters:
      serverName - name of called server
      projectGUID - unique identifier of the project
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      requestBody - filter response by team role
      Returns:
      a list of projects 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.

    • findProjects

      @PostMapping(path="/projects/by-search-string") public ProjectListResponse findProjects(@PathVariable String serverName, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of projects matching the search string.
      Parameters:
      serverName - name of the service to route the request to
      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:
      a list of projects 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.

    • getProjectsByName

      @PostMapping(path="/projects/by-name") public ProjectListResponse getProjectsByName(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of projects with a particular name.
      Parameters:
      serverName - name of called server
      requestBody - name of the projects to return - match is full text match in qualifiedName or name
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      Returns:
      a list of projects 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.

    • getProject

      @GetMapping(path="/projects/{projectGUID}") public ProjectResponse getProject(@PathVariable String serverName, @PathVariable String projectGUID)
      Return the properties of a specific project.
      Parameters:
      serverName - name of called server
      projectGUID - unique identifier of the required project
      Returns:
      project properties 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.

    • createProject

      @PostMapping(path="/projects") public GUIDResponse createProject(@PathVariable String serverName, @RequestParam(required=false) String classificationName, @RequestBody NewProjectRequestBody requestBody)
      Create a new generic project.
      Parameters:
      serverName - name of called server.
      classificationName - name of project classification
      requestBody - properties for the project.
      Returns:
      unique identifier of the newly created Project 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.

    • createTaskProject

      @PostMapping(path="/projects/{projectGUID}/task") public GUIDResponse createTaskProject(@PathVariable String serverName, @PathVariable String projectGUID, @RequestBody ProjectProperties requestBody)
      Create a new task linked to the supplied project. Used to identify a discrete piece of work within the project.
      Parameters:
      serverName - name of called server
      projectGUID - unique identifier of the project
      requestBody - properties for the project
      Returns:
      unique identifier of the newly created Project 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.

    • createProjectFromTemplate

      @PostMapping(path="/projects/from-template") public GUIDResponse createProjectFromTemplate(@PathVariable String serverName, @RequestBody TemplateRequestBody requestBody)
      Create a new metadata element to represent a project using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new project.
      Parameters:
      serverName - calling user
      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)

    • updateProject

      @PostMapping(path="/projects/{projectGUID}/update") public VoidResponse updateProject(@PathVariable String serverName, @PathVariable String projectGUID, @RequestParam boolean replaceAllProperties, @RequestBody ProjectProperties requestBody)
      Update the properties of a project.
      Parameters:
      serverName - name of called server.
      projectGUID - unique identifier of the project (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 project.
      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.

    • deleteProject

      @PostMapping(path="/projects/{projectGUID}/delete") public VoidResponse deleteProject(@PathVariable String serverName, @PathVariable String projectGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Delete a project. It is detected from all parent elements. If members are anchored to the project then they are also deleted.
      Parameters:
      serverName - name of called server.
      projectGUID - unique identifier of the project.
      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.

    • addToProjectTeam

      @PostMapping(path="/projects/{projectGUID}/members/{actorGUID}/attach") public VoidResponse addToProjectTeam(@PathVariable String serverName, @PathVariable String projectGUID, @PathVariable String actorGUID, @RequestBody(required=false) ProjectTeamProperties requestBody)
      Add an actor to a project.
      Parameters:
      serverName - name of called server.
      projectGUID - unique identifier of the project.
      requestBody - properties describing the membership characteristics.
      actorGUID - unique identifier of the actor.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem updating information in the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • removeFromProjectTeam

      @PostMapping(path="/projects/{projectGUID}/members/{actorGUID}/detach") public VoidResponse removeFromProjectTeam(@PathVariable String serverName, @PathVariable String projectGUID, @PathVariable String actorGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove an actor from a project.
      Parameters:
      serverName - name of called server.
      projectGUID - unique identifier of the project.
      actorGUID - unique identifier of the actor.
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem updating information in the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • setupProjectManagementRole

      @PostMapping(path="/projects/{projectGUID}/project-management-roles/{projectRoleGUID}/attach") public VoidResponse setupProjectManagementRole(@PathVariable String serverName, @PathVariable String projectGUID, @PathVariable String projectRoleGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Create a ProjectManagement relationship between a project and a person role to show that anyone appointed to the role is a member of the project.
      Parameters:
      serverName - name of the service to route the request to.
      projectGUID - unique identifier of the project
      projectRoleGUID - unique identifier of the person role
      requestBody - external 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)

    • clearProjectManagementRole

      @PostMapping(path="/projects/{projectGUID}/project-management-roles/{projectRoleGUID}/detach") public VoidResponse clearProjectManagementRole(@PathVariable String serverName, @PathVariable String projectGUID, @PathVariable String projectRoleGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove a ProjectManagement relationship between a project and a person role.
      Parameters:
      serverName - name of the service to route the request to.
      projectGUID - unique identifier of the project
      projectRoleGUID - unique identifier of the person role
      requestBody - external 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)