@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/subject-area")
public class SubjectAreaProjectRESTResource
extends SubjectAreaRESTServicesInstance
instanceHandler, oMRSAPIHelper| Constructor and Description |
|---|
SubjectAreaProjectRESTResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
SubjectAreaOMASAPIResponse |
createProject(String serverName,
String userId,
Project suppliedProject)
Create a Project.
|
SubjectAreaOMASAPIResponse |
deleteProject(String serverName,
String userId,
String guid,
Boolean isPurge)
Delete a Project instance
|
SubjectAreaOMASAPIResponse |
findProject(String serverName,
String userId,
String searchCriteria,
Date asOfTime,
Integer offset,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty)
Find Project
|
SubjectAreaOMASAPIResponse |
getProject(String serverName,
String userId,
String guid)
Get a Project.
|
SubjectAreaOMASAPIResponse |
getProjectRelationships(String serverName,
String userId,
String guid,
Date asOfTime,
Integer offset,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty) |
SubjectAreaOMASAPIResponse |
getProjectTerms(String serverName,
String userId,
String guid,
Date asOfTime) |
SubjectAreaOMASAPIResponse |
restoreProject(String serverName,
String userId,
String guid)
Restore a Project
Restore allows the deleted Project to be made active again.
|
SubjectAreaOMASAPIResponse |
updateProject(String serverName,
String userId,
String guid,
Project Project,
Boolean isReplace)
Update a Project
|
createLine, deleteLine, getLine, getRelationshipsFromGuid, initializeAPI, initializeAPI, restoreLine, setOMRSAPIHelper, updateLinepublic SubjectAreaProjectRESTResource()
@PostMapping(path="/users/{userId}/projects")
public SubjectAreaOMASAPIResponse createProject(@PathVariable
String serverName,
@PathVariable
String userId,
@RequestBody
Project suppliedProject)
serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId - unique identifier for requesting user, under which the request is performedsuppliedProject - Project to create@GetMapping(path="/users/{userId}/projects/{guid}")
public SubjectAreaOMASAPIResponse getProject(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId - userId under which the request is performedguid - guid of the Project to get@GetMapping(path="/users/{userId}/projects")
public SubjectAreaOMASAPIResponse findProject(@PathVariable
String serverName,
@PathVariable
String userId,
@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)
serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId - unique identifier for requesting user, under which the request is performedsearchCriteria - String expression matching Project property values. If not specified then all glossaries are returned.asOfTime - the glossaries 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 sizesequencingOrder - the sequencing order for the results.sequencingProperty - the name of the property that should be used to sequence the results.@GetMapping(path="/users/{userId}/projects/{guid}/relationships")
public SubjectAreaOMASAPIResponse getProjectRelationships(@PathVariable
String serverName,
@PathVariable
String userId,
@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)
@GetMapping(path="/users/{userId}/projects/{guid}/terms")
public SubjectAreaOMASAPIResponse getProjectTerms(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="asOfTime",required=false)
Date asOfTime)
@PutMapping(path="/users/{userId}/projects/{guid}")
public SubjectAreaOMASAPIResponse updateProject(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
Project Project,
@RequestParam(value="isReplace",required=false)
Boolean isReplace)
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.
serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId - unique identifier for requesting user, under which the request is performedguid - guid of the Project to updateProject - Project to updateisReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.@DeleteMapping(path="/users/{userId}/projects/{guid}")
public SubjectAreaOMASAPIResponse deleteProject(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="isPurge",required=false)
Boolean isPurge)
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
serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId - unique identifier for requesting user, under which the request is performedguid - guid of the Project to be deleted.isPurge - true indicates a hard delete, false is a soft delete.@PostMapping(path="/users/{userId}/projects/{guid}")
public SubjectAreaOMASAPIResponse restoreProject(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId - unique identifier for requesting user, under which the request is performedguid - guid of the Project to restoreCopyright © 2018–2020 ODPi. All rights reserved.