@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/subject-area")
public class SubjectAreaGlossaryRESTResource
extends SubjectAreaRESTServicesInstance
instanceHandler, oMRSAPIHelper| Constructor and Description |
|---|
SubjectAreaGlossaryRESTResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
SubjectAreaOMASAPIResponse |
createGlossary(String serverName,
String userId,
Glossary suppliedGlossary)
Create a Glossary.
|
SubjectAreaOMASAPIResponse |
deleteGlossary(String serverName,
String userId,
String guid,
Boolean isPurge)
Delete a Glossary instance
|
SubjectAreaOMASAPIResponse |
findGlossary(String serverName,
String userId,
String searchCriteria,
Date asOfTime,
Integer offset,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty)
Find Glossary
|
SubjectAreaOMASAPIResponse |
getGlossary(String serverName,
String userId,
String guid)
Get a glossary.
|
SubjectAreaOMASAPIResponse |
getGlossaryRelationships(String serverName,
String userId,
String guid,
Date asOfTime,
Integer offset,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty) |
SubjectAreaOMASAPIResponse |
restoreGlossary(String serverName,
String userId,
String guid)
Restore a Glossary
Restore allows the deleted Glossary to be made active again.
|
SubjectAreaOMASAPIResponse |
updateGlossary(String serverName,
String userId,
String guid,
Glossary glossary,
Boolean isReplace)
Update a Glossary
|
createLine, deleteLine, getLine, getRelationshipsFromGuid, initializeAPI, initializeAPI, restoreLine, setOMRSAPIHelper, updateLinepublic SubjectAreaGlossaryRESTResource()
@RequestMapping(method=POST,
path="/users/{userId}/glossaries")
public SubjectAreaOMASAPIResponse createGlossary(@PathVariable
String serverName,
@PathVariable
String userId,
@RequestBody
Glossary suppliedGlossary)
Valid nodeTypes for this request are:
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 performedsuppliedGlossary - Glossary to create@RequestMapping(method=GET,
path="/users/{userId}/glossaries/{guid}")
public SubjectAreaOMASAPIResponse getGlossary(@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 glossary to get@RequestMapping(method=GET,
path="/users/{userId}/glossaries")
public SubjectAreaOMASAPIResponse findGlossary(@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 Glossary 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.@RequestMapping(method=GET,
path="/users/{userId}/glossaries/{guid}/relationships")
public SubjectAreaOMASAPIResponse getGlossaryRelationships(@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}/glossaries/{guid}")
public SubjectAreaOMASAPIResponse updateGlossary(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
Glossary glossary,
@RequestParam(value="isReplace",required=false)
Boolean isReplace)
If the caller has chosen to incorporate the glossary name in their Glossary Terms or Categories qualified name, renaming the glossary will cause those qualified names to mismatch the Glossary name. If the caller has chosen to incorporate the glossary qualifiedName in their Glossary Terms or Categories qualified name, changing the qualified name of the glossary will cause those qualified names to mismatch the Glossary 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 glossary to updateglossary - glossary to updateisReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.@RequestMapping(method=DELETE,
path="/users/{userId}/glossaries/{guid}")
public SubjectAreaOMASAPIResponse deleteGlossary(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="isPurge",required=false)
Boolean isPurge)
The deletion of a glossary is only allowed if there is no glossary 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 glossary 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 glossary 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 glossary to be deleted.isPurge - true indicates a hard delete, false is a soft delete.@RequestMapping(method=POST,
path="/users/{userId}/glossaries/{guid}")
public SubjectAreaOMASAPIResponse restoreGlossary(@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 glossary to restoreCopyright © 2018–2019 ODPi. All rights reserved.