Package org.odpi.openmetadata.viewservices.glossaryauthor.server

Class GlossaryAuthorViewProjectRESTResource

java.lang.Object
org.odpi.openmetadata.viewservices.glossaryauthor.server.GlossaryAuthorViewProjectRESTResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/view-services/glossary-author/users/{userId}/projects") public class GlossaryAuthorViewProjectRESTResource extends Object
The GlossaryAuthorRESTServicesInstance provides the org.odpi.openmetadata.viewservices.glossaryauthor.server implementation of the Glossary Author Open Metadata View Service (OMVS) for projects. This interface provides project authoring interfaces for subject area experts.

  • Constructor Details

    • GlossaryAuthorViewProjectRESTResource

      public GlossaryAuthorViewProjectRESTResource()
      Default constructor

  • Method Details

    • createProject

      @PostMapping public SubjectAreaOMASAPIResponse<Project> createProject(@PathVariable String serverName, @PathVariable String userId, @RequestBody Project suppliedProject)
      Create a Project.

      Projects with the same name can be confusing. Best practise is to create projects that have unique names. This Create call does not police that Project names are unique. So it is possible to create projects with the same name as each other.

      Projects that are created using this call will be GlossaryProjects.

      Parameters:
      serverName - name of the local server.
      userId - userid
      suppliedProject - Project to create.
      Returns:
      response, when successful contains the created project. when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getProject

      @GetMapping(path="/{guid}") public SubjectAreaOMASAPIResponse<Project> getProject(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Get a project.
      Parameters:
      serverName - local UI server name
      userId - userid
      guid - guid of the project to get
      Returns:
      response which when successful contains the project with the requested guid when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • findProject

      @GetMapping public SubjectAreaOMASAPIResponse<Project> findProject(@PathVariable String serverName, @PathVariable String userId, @RequestParam(value="searchCriteria",required=false) String searchCriteria, @RequestParam(value="exactValue",required=false,defaultValue="false") Boolean exactValue, @RequestParam(value="ignoreCase",required=false,defaultValue="true") Boolean ignoreCase, @RequestParam(value="asOfTime",required=false) Date asOfTime, @RequestParam(value="startingFrom",required=false) Integer startingFrom, @RequestParam(value="pageSize",required=false) Integer pageSize, @RequestParam(value="sequencingOrder",required=false) SequencingOrder sequencingOrder, @RequestParam(value="sequencingProperty",required=false) String sequencingProperty)
      Find Project
      Parameters:
      serverName - local UI server name
      userId - userid
      searchCriteria - String expression matching Project property values.
      exactValue - a boolean, which when set means that only exact matches will be returned, otherwise matches that start with the search criteria will be returned.
      ignoreCase - a boolean, which when set means that case will be ignored, if not set that case will be respected
      asOfTime - the projects returned as they were at this time. null indicates at the current time.
      startingFrom - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.
      pageSize - the maximum number of elements that can be returned on this request.
      sequencingOrder - the sequencing order for the results.
      sequencingProperty - the name of the property that should be used to sequence the results.
      Returns:
      A list of projects meeting the search Criteria
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getProjectRelationships

      @GetMapping(path="/{guid}/relationships") public SubjectAreaOMASAPIResponse<Relationship> getProjectRelationships(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestParam(value="asOfTime",required=false) Date asOfTime, @RequestParam(value="startingFrom",required=false) Integer startingFrom, @RequestParam(value="pageSize",required=false) Integer pageSize, @RequestParam(value="sequencingOrder",required=false) SequencingOrder sequencingOrder, @RequestParam(value="sequencingProperty",required=false) String sequencingProperty)
      Get Project relationships. The server has a maximum page size defined, the number of relationships returned is limited by that maximum page size.
      Parameters:
      serverName - local UI server name
      userId - userid
      guid - guid of the project to get
      asOfTime - the relationships returned as they were at this time. null indicates at the current time. If specified, the date is in milliseconds since 1970-01-01 00:00:00.
      startingFrom - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.
      pageSize - the maximum number of elements that can be returned on this request.
      sequencingOrder - the sequencing order for the results.
      sequencingProperty - the name of the property that should be used to sequence the results.
      Returns:
      a response which when successful contains the project relationships when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateProject

      @PutMapping(path="/{guid}") public SubjectAreaOMASAPIResponse<Project> updateProject(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody Project suppliedProject, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace)
      Update a Project

      Status is not updated using this call.

      Parameters:
      serverName - local UI server name
      userId - userid
      guid - guid of the project to update
      suppliedProject - project to update
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      a response which when successful contains the updated project when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteProject

      @DeleteMapping(path="/{guid}") public SubjectAreaOMASAPIResponse<Project> deleteProject(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Delete a Project instance

      The deletion of a project is only allowed if there is no project content (i.e. no terms or categories).

      There are 2 types of deletion, a soft delete and a hard delete (also known as a purge). All repositories support hard deletes. Soft deletes support is optional.

      A soft delete means that the project instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete. A hard delete means that the project will not exist after the operation. when not successful the following Exceptions can occur

      Parameters:
      serverName - local UI server name
      userId - userid
      guid - guid of the project to be deleted.
      Returns:
      a void response when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreProject

      @PostMapping(path="/{guid}") public SubjectAreaOMASAPIResponse<Project> restoreProject(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Restore a Project

      Restore allows the deleted Project to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      serverName - local UI server name
      userId - userid
      guid - guid of the project to restore
      Returns:
      response which when successful contains the restored project when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.