@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/view-services/glossary-author/users/{userId}/terms")
public class GlossaryAuthorViewTermRESTResource
extends Object
| Constructor and Description |
|---|
GlossaryAuthorViewTermRESTResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
SubjectAreaOMASAPIResponse<Term> |
createTerm(String serverName,
String userId,
Term suppliedTerm)
Create a Term.
|
SubjectAreaOMASAPIResponse<Term> |
deleteTerm(String serverName,
String userId,
String guid,
Boolean isPurge)
Delete a Term instance
|
SubjectAreaOMASAPIResponse<Term> |
findTerm(String serverName,
String userId,
String searchCriteria,
Date asOfTime,
Integer startingFrom,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty)
Find Term
|
SubjectAreaOMASAPIResponse<Term> |
getTerm(String serverName,
String userId,
String guid)
Get a term.
|
SubjectAreaOMASAPIResponse<Category> |
getTermCategories(String serverName,
String userId,
String guid,
Integer startingFrom,
Integer pageSize)
Get the Categories categorizing this Term.
|
SubjectAreaOMASAPIResponse<Line> |
getTermRelationships(String serverName,
String userId,
String guid,
Date asOfTime,
Integer startingFrom,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty)
Get Term relationships.
|
SubjectAreaOMASAPIResponse<Term> |
restoreTerm(String serverName,
String userId,
String guid)
Restore a Term
|
SubjectAreaOMASAPIResponse<Term> |
updateTerm(String serverName,
String userId,
String guid,
Term suppliedTerm,
Boolean isReplace)
Update a Term
|
public GlossaryAuthorViewTermRESTResource()
@PostMapping public SubjectAreaOMASAPIResponse<Term> createTerm(@PathVariable String serverName, @PathVariable String userId, @RequestBody Term suppliedTerm)
Terms with the same name can be confusing. Best practise is to create terms that have unique names. This Create call does not police that Term names are unique. So it is possible to create terms with the same name as each other.
serverName - name of the local server.userId - useridsuppliedTerm - Term to create.@GetMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Term> getTerm(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - local UI server nameuserId - useridguid - guid of the term to get@GetMapping public SubjectAreaOMASAPIResponse<Term> findTerm(@PathVariable String serverName, @PathVariable String userId, @RequestParam(value="searchCriteria",required=false) String searchCriteria, @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)
serverName - local UI server nameuserId - useridsearchCriteria - String expression matching Term property values .asOfTime - the terms 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.@GetMapping(path="/{guid}/relationships")
public SubjectAreaOMASAPIResponse<Line> getTermRelationships(@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)
serverName - local UI server nameuserId - useridguid - guid of the term to getasOfTime - 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.@PutMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Term> updateTerm(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
Term suppliedTerm,
@RequestParam(value="isReplace",required=false,defaultValue="false")
Boolean isReplace)
Status is not updated using this call. The Categories categorising this Term can be amended using this call. For an update (rather than a replace) with no categories supplied, no changes are made to the categories; otherwise the supplied categories will replace the existing ones. The server has a maximum page size defined, the number of categories returned is limited by that maximum page size.
serverName - local UI server nameuserId - useridguid - guid of the term to updatesuppliedTerm - term to updateisReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.@DeleteMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Term> deleteTerm(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="isPurge",required=false,defaultValue="false")
Boolean isPurge)
The deletion of a term is only allowed if there is no term 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. 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 Exceptions can occur
serverName - local UI server nameuserId - useridguid - guid of the term to be deleted.isPurge - true indicates a hard delete, false is a soft delete.@PostMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Term> restoreTerm(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
Restore allows the deleted Term to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
serverName - local UI server nameuserId - useridguid - guid of the term to restore@GetMapping(path="{guid}/categories")
public SubjectAreaOMASAPIResponse<Category> getTermCategories(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="startingFrom",required=false,defaultValue="0")
Integer startingFrom,
@RequestParam(value="pageSize",required=false)
Integer pageSize)
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 category to get termsstartingFrom - the starting element number for this set of results. This is used when retrieving elementspageSize - the maximum number of elements that can be returned on this request.Copyright © 2018–2021 LF AI & Data Foundation. All rights reserved.