@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/subject-area")
public class SubjectAreaGlossaryRESTResource
extends Object
| Constructor and Description |
|---|
SubjectAreaGlossaryRESTResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
SubjectAreaOMASAPIResponse<Glossary> |
createGlossary(String serverName,
String userId,
Glossary suppliedGlossary)
Create a Glossary.
|
SubjectAreaOMASAPIResponse<Glossary> |
deleteGlossary(String serverName,
String userId,
String guid,
Boolean isPurge)
Delete a Glossary instance
|
SubjectAreaOMASAPIResponse<Glossary> |
findGlossary(String serverName,
String userId,
String searchCriteria,
Date asOfTime,
Integer startingFrom,
Integer pageSize,
String sequencingOrder,
String sequencingProperty)
Find Glossary
|
SubjectAreaOMASAPIResponse<Glossary> |
getGlossary(String serverName,
String userId,
String guid)
Get a glossary.
|
SubjectAreaOMASAPIResponse<Category> |
getGlossaryCategories(String serverName,
String userId,
String guid,
String searchCriteria,
Date asOfTime,
Boolean onlyTop,
Integer startingFrom,
Integer pageSize,
String sequencingOrder,
String sequencingProperty)
Get the Categories owned by this glossary.
|
SubjectAreaOMASAPIResponse<Relationship> |
getGlossaryRelationships(String serverName,
String userId,
String guid,
Date asOfTime,
Integer startingFrom,
Integer pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty)
Get Glossary relationships
|
SubjectAreaOMASAPIResponse<Term> |
getGlossaryTerms(String serverName,
String userId,
String guid,
String searchCriteria,
Date asOfTime,
Integer startingFrom,
Integer pageSize,
String sequencingOrder,
String sequencingProperty)
Get terms that are owned by this glossary.
|
SubjectAreaOMASAPIResponse<Glossary> |
restoreGlossary(String serverName,
String userId,
String guid)
Restore a Glossary
|
SubjectAreaOMASAPIResponse<Glossary> |
updateGlossary(String serverName,
String userId,
String guid,
Glossary glossary,
Boolean isReplace)
Update a Glossary
|
public SubjectAreaGlossaryRESTResource()
@PostMapping(path="/users/{userId}/glossaries")
public SubjectAreaOMASAPIResponse<Glossary> 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@GetMapping(path="/users/{userId}/glossaries/{guid}")
public SubjectAreaOMASAPIResponse<Glossary> 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@GetMapping(path="/users/{userId}/glossaries")
public SubjectAreaOMASAPIResponse<Glossary> findGlossary(@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,defaultValue="0")
Integer startingFrom,
@RequestParam(value="pageSize",required=false)
Integer pageSize,
@RequestParam(value="sequencingOrder",required=false)
String 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.startingFrom - 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.sequencingOrder - the sequencing order for the results.sequencingProperty - the name of the property that should be used to sequence the results.@GetMapping(path="/users/{userId}/glossaries/{guid}/relationships")
public SubjectAreaOMASAPIResponse<Relationship> getGlossaryRelationships(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="asOfTime",required=false)
Date asOfTime,
@RequestParam(value="startingFrom",required=false,defaultValue="0")
Integer startingFrom,
@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 performedguid - guid of the glossary 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="/users/{userId}/glossaries/{guid}")
public SubjectAreaOMASAPIResponse<Glossary> updateGlossary(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestBody
Glossary glossary,
@RequestParam(value="isReplace",required=false,defaultValue="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.@DeleteMapping(path="/users/{userId}/glossaries/{guid}")
public SubjectAreaOMASAPIResponse<Glossary> deleteGlossary(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="isPurge",required=false,defaultValue="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.@PostMapping(path="/users/{userId}/glossaries/{guid}")
public SubjectAreaOMASAPIResponse<Glossary> restoreGlossary(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
Restore allows the deleted Glossary to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
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 restore@GetMapping(path="/users/{userId}/glossaries/{guid}/terms")
public SubjectAreaOMASAPIResponse<Term> getGlossaryTerms(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="searchCriteria",required=false)
String searchCriteria,
@RequestParam(value="asOfTime",required=false)
Date asOfTime,
@RequestParam(value="startingFrom",required=false,defaultValue="0")
Integer startingFrom,
@RequestParam(value="pageSize",required=false)
Integer pageSize,
@RequestParam(value="sequencingOrder",required=false)
String 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 performedguid - guid of the category to get termsasOfTime - the terms returned as they were at this time. null indicates at the current time.searchCriteria - String expression matching child Term property values.startingFrom - the starting element number for this set of results. This is used when retrieving elementspageSize - Return the maximum number of elements that can be returned on this request.@GetMapping(path="/users/{userId}/glossaries/{guid}/categories")
public SubjectAreaOMASAPIResponse<Category> getGlossaryCategories(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam(value="searchCriteria",required=false)
String searchCriteria,
@RequestParam(value="asOfTime",required=false)
Date asOfTime,
@RequestParam(value="onlyTop",required=false,defaultValue="true")
Boolean onlyTop,
@RequestParam(value="startingFrom",required=false,defaultValue="0")
Integer startingFrom,
@RequestParam(value="pageSize",required=false)
Integer pageSize,
@RequestParam(value="sequencingOrder",required=false)
String 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 performedguid - guid of the glossary to get termssearchCriteria - String expression matching child Category property values.asOfTime - the categories 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 elementspageSize - the maximum number of elements that can be returned on this request.onlyTop - when only the top categories (those categories without parents) are returned.Copyright © 2018–2021 LF AI & Data Foundation. All rights reserved.