@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/subject-area")
public class SubjectAreaTermRESTResource
extends SubjectAreaRESTServicesInstance
instanceHandler, oMRSAPIHelper| Constructor and Description |
|---|
SubjectAreaTermRESTResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
SubjectAreaOMASAPIResponse |
createTerm(String serverName,
String userId,
Term suppliedTerm)
Create a Term
|
SubjectAreaOMASAPIResponse |
deleteTerm(String serverName,
String userId,
String guid,
Boolean isPurge)
Delete a Term instance
|
SubjectAreaOMASAPIResponse |
findTerm(String serverName,
String userId,
String searchCriteria,
Date asOfTime,
Integer offset,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty)
Find Term
|
SubjectAreaOMASAPIResponse |
getTermByGuid(String serverName,
String userId,
String guid)
Get a Term
|
SubjectAreaOMASAPIResponse |
getTermRelationships(String serverName,
String userId,
String guid,
Date asOfTime,
Integer offset,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty) |
SubjectAreaOMASAPIResponse |
restoreTerm(String serverName,
String userId,
String guid)
Restore a Term
Restore allows the deleted Term to be made active again.
|
SubjectAreaOMASAPIResponse |
updateTerm(String serverName,
String userId,
String guid,
Term suppliedTerm,
Boolean isReplace)
Update a Term
|
createLine, deleteLine, getLine, getRelationshipsFromGuid, initializeAPI, initializeAPI, restoreLine, setOMRSAPIHelper, updateLinepublic SubjectAreaTermRESTResource()
@RequestMapping(method=POST,
path="/users/{userId}/terms")
public SubjectAreaOMASAPIResponse createTerm(@PathVariable
String serverName,
@PathVariable
String userId,
@RequestBody
Term suppliedTerm)
The name needs to be specified - as this is the main identifier for the term. The name should be unique for canonical glossaries. This API does not police the uniqueness in this case.
The qualifiedName can be specified and will be honoured. If it is specified then the caller may wish to ensure that it is unique. If this qualifiedName is not specified then one will be generated as GlossaryTerm concatinated with the the guid.
Failure to create the Terms classifications, link to its glossary or its icon, results in the create failing and the term being deleted
serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId - userIdsuppliedTerm - term to create@RequestMapping(method=GET,
path="/users/{userId}/terms/{guid}")
public SubjectAreaOMASAPIResponse getTermByGuid(@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 term to get@RequestMapping(method=GET,
path="/users/{userId}/terms")
public SubjectAreaOMASAPIResponse findTerm(@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 Term property values (this does not include the GlossarySummary content). When not specified, all terms are returned.asOfTime - the relationships 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.@RequestMapping(method=GET,
path="/users/{userId}/terms/{guid}/relationships")
public SubjectAreaOMASAPIResponse getTermRelationships(@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)
@RequestMapping(method=PUT,
path="/users/{userId}/terms/{guid}")
public SubjectAreaOMASAPIResponse updateTerm(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
Term suppliedTerm,
@RequestParam(value="isReplace",required=false)
Boolean isReplace)
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 - userId under which the request is performedguid - guid of the term to updatesuppliedTerm - term to be updatedisReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated. The GovernanceAction content is always replaced.@RequestMapping(method=DELETE,
path="/users/{userId}/terms/{guid}")
public SubjectAreaOMASAPIResponse deleteTerm(@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 term 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 term will not exist after the operation. when not successful the following Exception responses can occur
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 term to be deleted.isPurge - true indicates a hard delete, false is a soft delete.@RequestMapping(method=POST,
path="/users/{userId}/terms/{guid}")
public SubjectAreaOMASAPIResponse restoreTerm(@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 term to deleteCopyright © 2018–2019 ODPi. All rights reserved.