org.odpi.openmetadata.userinterface.uichassis.springboot.api.subjectarea

Class SubjectAreaProjectController

java.lang.Object

org.odpi.openmetadata.userinterface.uichassis.springboot.api.SecureController

org.odpi.openmetadata.userinterface.uichassis.springboot.api.subjectarea.SubjectAreaProjectController

@RestController
 @RequestMapping(value="/api/subject-area/projects")
public class SubjectAreaProjectController
extends SecureController

The SubjectAreaRESTServicesInstance provides the org.odpi.openmetadata.accessservices.subjectarea.server-side implementation of the SubjectAreaDefinition Open Metadata Assess Service (OMAS). This interface provides project authoring interfaces for subject area experts.

Constructor Summary

Constructors

Constructor and Description
SubjectAreaProjectController(SubjectArea subjectArea) Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	createProject(Project suppliedProject, javax.servlet.http.HttpServletRequest request) Create a Project.
SubjectAreaOMASAPIResponse	deleteProject(String guid, Boolean isPurge, javax.servlet.http.HttpServletRequest request) Delete a Project instance
SubjectAreaOMASAPIResponse	findProject(String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty, javax.servlet.http.HttpServletRequest request) Find Project
SubjectAreaOMASAPIResponse	getProject(String guid, javax.servlet.http.HttpServletRequest request) Get a project.
SubjectAreaOMASAPIResponse	getProjectRelationships(String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty, javax.servlet.http.HttpServletRequest request)
SubjectAreaOMASAPIResponse	restoreProject(String guid, javax.servlet.http.HttpServletRequest request) Restore a Project Restore allows the deleted Project to be made active again.
SubjectAreaOMASAPIResponse	updateProject(String guid, Project project, Boolean isReplace, javax.servlet.http.HttpServletRequest request) Update a Project

Methods inherited from class org.odpi.openmetadata.userinterface.uichassis.springboot.api.SecureController

getUser

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaProjectController

public SubjectAreaProjectController(SubjectArea subjectArea)

Default constructor

Parameters:

subjectArea - main client object for the Subject Area OMAS

Method Detail

createProject

@PostMapping
public SubjectAreaOMASAPIResponse createProject(@RequestBody
                                                             Project suppliedProject,
                                                             javax.servlet.http.HttpServletRequest request)

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:

suppliedProject - Project to create

request - HttpServletRequest the servlet request

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.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised.
• ClassificationException Error processing a classification.
• StatusNotSupportedException A status value is not supported.

getProject

@GetMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse getProject(@PathVariable
                                                                         String guid,
                                                                         javax.servlet.http.HttpServletRequest request)

Get a project.

Parameters:

guid - guid of the project to get

request - HttpServletRequest the servlet request

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.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised
• UnrecognizedGUIDException the supplied guid was not recognised
• FunctionNotSupportedException Function not supported

findProject

@GetMapping
public SubjectAreaOMASAPIResponse findProject(@RequestParam(value="searchCriteria",required=false)
                                                          String searchCriteria,
                                                          @RequestParam(value="asOfTime",required=false)
                                                          Date asOfTime,
                                                          @RequestParam(value="offset",required=false)
                                                          Integer offset,
                                                          @RequestParam(value="pageSize",required=false)
                                                          Integer pageSize,
                                                          @RequestParam(value="sequencingOrder",required=false)
                                                          SequencingOrder sequencingOrder,
                                                          @RequestParam(value="SequencingProperty",required=false)
                                                          String sequencingProperty,
                                                          javax.servlet.http.HttpServletRequest request)

Find Project

Parameters:

searchCriteria - String expression matching Project property values .

asOfTime - the projects returned as they were at this time. null indicates at the current time.

offset - 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. 0 means there is no limit to the page size

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

request - HttpServletRequest the servlet request

Returns:

A list of projects meeting the search Criteria

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• FunctionNotSupportedException Function not supported.

getProjectRelationships

@GetMapping(path="/{guid}/relationships")
public SubjectAreaOMASAPIResponse getProjectRelationships(@PathVariable
                                                                                                    String guid,
                                                                                                    @RequestParam(value="asOfTime",required=false)
                                                                                                    Date asOfTime,
                                                                                                    @RequestParam(value="offset",required=false)
                                                                                                    Integer offset,
                                                                                                    @RequestParam(value="pageSize",required=false)
                                                                                                    Integer pageSize,
                                                                                                    @RequestParam(value="sequencingOrder",required=false)
                                                                                                    SequencingOrder sequencingOrder,
                                                                                                    @RequestParam(value="SequencingProperty",required=false)
                                                                                                    String sequencingProperty,
                                                                                                    javax.servlet.http.HttpServletRequest request)

updateProject

@PutMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse updateProject(@PathVariable
                                                                            String guid,
                                                                            @RequestBody
                                                                            Project project,
                                                                            @RequestParam(value="isReplace",required=false)
                                                                            Boolean isReplace,
                                                                            javax.servlet.http.HttpServletRequest request)

Update a Project

If the caller has chosen to incorporate the project name in their Project Terms or Categories qualified name, renaming the project will cause those qualified names to mismatch the Project name. If the caller has chosen to incorporate the project qualifiedName in their Project Terms or Categories qualified name, changing the qualified name of the project will cause those qualified names to mismatch the Project name. Status is not updated using this call.

Parameters:

guid - guid of the project to update

project - project to update

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

request - HttpServletRequest the servlet request

Returns:

a response which when successful contains the updated project when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.

deleteProject

@DeleteMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse deleteProject(@PathVariable
                                                                               String guid,
                                                                               @RequestParam(value="isPurge",required=false)
                                                                               Boolean isPurge,
                                                                               javax.servlet.http.HttpServletRequest request)

Delete a Project instance

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. Soft delete is the default.

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:

guid - guid of the project to be deleted.

isPurge - true indicates a hard delete, false is a soft delete.

request - HttpServletRequest the servlet request

Returns:

a void response when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
• EntityNotDeletedException a soft delete was issued but the project was not deleted.
• GUIDNotPurgedException a hard delete was issued but the project was not purged

restoreProject

@PostMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse restoreProject(@PathVariable
                                                                              String guid,
                                                                              javax.servlet.http.HttpServletRequest request)

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:

guid - guid of the project to restore

request - HttpServletRequest the servlet request

Returns:

response which when successful contains the restored project when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.