public final class GlossaryBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
DynamicRequest |
assignTermToEntities(String termGuid)
Assign the given term to the provided list of related objects.
|
DynamicRequest |
createGlossary()
Create a glossary.
|
DynamicRequest |
createGlossaryCategories()
Create glossary category in bulk.
|
DynamicRequest |
createGlossaryCategory()
Create a glossary category.
|
DynamicRequest |
createGlossaryTerm()
Create a glossary term.
|
DynamicRequest |
createGlossaryTerms()
Create glossary terms in bulk.
|
DynamicRequest |
deleteGlossary(String glossaryGuid)
Delete a glossary.
|
DynamicRequest |
deleteGlossaryCategory(String categoryGuid)
Delete a glossary category.
|
DynamicRequest |
deleteGlossaryTerm(String termGuid)
Delete a glossary term.
|
DynamicRequest |
deleteTermAssignmentFromEntities(String termGuid)
Delete the term assignment for the given list of related objects.
|
DynamicRequest |
exportGlossaryTermsAsCsv(String glossaryGuid)
Export Glossary Terms as csv file.
|
DynamicRequest |
getDetailedGlossary(String glossaryGuid)
Get a specific glossary with detailed information.
|
DynamicRequest |
getEntitiesAssignedWithTerm(String termGuid)
Get all related objects assigned with the specified term.
|
DynamicRequest |
getGlossary(String glossaryGuid)
Get a specific Glossary by its GUID.
|
DynamicRequest |
getGlossaryCategory(String categoryGuid)
Get specific glossary category by its GUID.
|
DynamicRequest |
getGlossaryTerm(String termGuid)
Get a specific glossary term by its GUID.
|
DynamicRequest |
getImportCsvOperationStatus(String operationGuid)
Get the status of import csv operation.
|
DynamicRequest |
importGlossaryTermsViaCsv(String glossaryGuid,
long contentLength)
Import Glossary Terms from local csv file.
|
DynamicRequest |
importGlossaryTermsViaCsvByGlossaryName(String glossaryName,
long contentLength)
Import Glossary Terms from local csv file by glossaryName.
|
DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
DynamicRequest |
listCategoryTerms(String categoryGuid)
Get all terms associated with the specific category.
|
DynamicRequest |
listGlossaries()
Get all glossaries registered with Atlas.
|
DynamicRequest |
listGlossaryCategories(String glossaryGuid)
Get the categories belonging to a specific glossary.
|
DynamicRequest |
listGlossaryCategoriesHeaders(String glossaryGuid)
Get the category headers belonging to a specific glossary.
|
DynamicRequest |
listGlossaryTermHeaders(String glossaryGuid)
Get term headers belonging to a specific glossary.
|
DynamicRequest |
listGlossaryTerms(String glossaryGuid)
Get terms belonging to a specific glossary.
|
DynamicRequest |
listRelatedCategories(String categoryGuid)
Get all related categories (parent and children).
|
DynamicRequest |
listRelatedTerms(String termGuid)
Get all related terms for a specific term by its GUID.
|
DynamicRequest |
listTermsByGlossaryName(String glossaryName)
Get terms by glossary name.
|
DynamicRequest |
partialUpdateGlossary(String glossaryGuid)
Update the glossary partially.
|
DynamicRequest |
partialUpdateGlossaryCategory(String categoryGuid)
Update the glossary category partially.
|
DynamicRequest |
partialUpdateGlossaryTerm(String termGuid)
Update the glossary term partially.
|
DynamicRequest |
removeTermAssignmentFromEntities(String termGuid)
Delete the term assignment for the given list of related objects.
|
DynamicRequest |
updateGlossary(String glossaryGuid)
Update the given glossary.
|
DynamicRequest |
updateGlossaryCategory(String categoryGuid)
Update the given glossary category by its GUID.
|
DynamicRequest |
updateGlossaryTerm(String termGuid)
Update the given glossary term by its GUID.
|
public DynamicRequest listGlossaries()
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
[
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
categories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
language: String
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
usage: String
}
]
public DynamicRequest createGlossary()
Request Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
categories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
language: String
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
usage: String
}
Response Body Schema
(recursive schema, see above)
public DynamicRequest createGlossaryCategories()
Request Body Schema
[
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
childrenCategories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
parentCategory: (recursive schema, see parentCategory above)
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
}
]
Response Body Schema
[
(recursive schema, see above)
]
public DynamicRequest createGlossaryCategory()
Request Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
childrenCategories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
parentCategory: (recursive schema, see parentCategory above)
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
}
Response Body Schema
(recursive schema, see above)
public DynamicRequest getGlossaryCategory(String categoryGuid)
Response Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
childrenCategories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
parentCategory: (recursive schema, see parentCategory above)
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
}
categoryGuid
- The globally unique identifier of the category.public DynamicRequest updateGlossaryCategory(String categoryGuid)
Request Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
childrenCategories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
parentCategory: (recursive schema, see parentCategory above)
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
}
Response Body Schema
(recursive schema, see above)
categoryGuid
- The globally unique identifier of the category.public DynamicRequest deleteGlossaryCategory(String categoryGuid)
categoryGuid
- The globally unique identifier of the category.public DynamicRequest partialUpdateGlossaryCategory(String categoryGuid)
Request Body Schema
{
String: String
}
Response Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
childrenCategories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
parentCategory: (recursive schema, see parentCategory above)
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
}
categoryGuid
- The globally unique identifier of the category.public DynamicRequest listRelatedCategories(String categoryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
{
String: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
}
categoryGuid
- The globally unique identifier of the category.public DynamicRequest listCategoryTerms(String categoryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
[
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
categoryGuid
- The globally unique identifier of the category.public DynamicRequest createGlossaryTerm()
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Request Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
abbreviation: String
templateName: [
Object
]
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
antonyms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
createTime: Float
createdBy: String
updateTime: Float
updatedBy: String
status: String(Draft/Approved/Alert/Expired)
resources: [
{
displayName: String
url: String
}
]
contacts: {
String: [
{
id: String
info: String
}
]
}
attributes: {
String: {
String: Object
}
}
assignedEntities: [
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
categories: [
{
categoryGuid: String
description: String
displayText: String
relationGuid: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
}
]
classifies: [
(recursive schema, see above)
]
examples: [
String
]
isA: [
(recursive schema, see above)
]
preferredTerms: [
(recursive schema, see above)
]
preferredToTerms: [
(recursive schema, see above)
]
replacedBy: [
(recursive schema, see above)
]
replacementTerms: [
(recursive schema, see above)
]
seeAlso: [
(recursive schema, see above)
]
synonyms: [
(recursive schema, see above)
]
translatedTerms: [
(recursive schema, see above)
]
translationTerms: [
(recursive schema, see above)
]
usage: String
validValues: [
(recursive schema, see above)
]
validValuesFor: [
(recursive schema, see above)
]
}
Response Body Schema
(recursive schema, see above)
public DynamicRequest getGlossaryTerm(String termGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Response Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
abbreviation: String
templateName: [
Object
]
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
antonyms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
createTime: Float
createdBy: String
updateTime: Float
updatedBy: String
status: String(Draft/Approved/Alert/Expired)
resources: [
{
displayName: String
url: String
}
]
contacts: {
String: [
{
id: String
info: String
}
]
}
attributes: {
String: {
String: Object
}
}
assignedEntities: [
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
categories: [
{
categoryGuid: String
description: String
displayText: String
relationGuid: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
}
]
classifies: [
(recursive schema, see above)
]
examples: [
String
]
isA: [
(recursive schema, see above)
]
preferredTerms: [
(recursive schema, see above)
]
preferredToTerms: [
(recursive schema, see above)
]
replacedBy: [
(recursive schema, see above)
]
replacementTerms: [
(recursive schema, see above)
]
seeAlso: [
(recursive schema, see above)
]
synonyms: [
(recursive schema, see above)
]
translatedTerms: [
(recursive schema, see above)
]
translationTerms: [
(recursive schema, see above)
]
usage: String
validValues: [
(recursive schema, see above)
]
validValuesFor: [
(recursive schema, see above)
]
}
termGuid
- The globally unique identifier for glossary term.public DynamicRequest updateGlossaryTerm(String termGuid)
Request Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
abbreviation: String
templateName: [
Object
]
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
antonyms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
createTime: Float
createdBy: String
updateTime: Float
updatedBy: String
status: String(Draft/Approved/Alert/Expired)
resources: [
{
displayName: String
url: String
}
]
contacts: {
String: [
{
id: String
info: String
}
]
}
attributes: {
String: {
String: Object
}
}
assignedEntities: [
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
categories: [
{
categoryGuid: String
description: String
displayText: String
relationGuid: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
}
]
classifies: [
(recursive schema, see above)
]
examples: [
String
]
isA: [
(recursive schema, see above)
]
preferredTerms: [
(recursive schema, see above)
]
preferredToTerms: [
(recursive schema, see above)
]
replacedBy: [
(recursive schema, see above)
]
replacementTerms: [
(recursive schema, see above)
]
seeAlso: [
(recursive schema, see above)
]
synonyms: [
(recursive schema, see above)
]
translatedTerms: [
(recursive schema, see above)
]
translationTerms: [
(recursive schema, see above)
]
usage: String
validValues: [
(recursive schema, see above)
]
validValuesFor: [
(recursive schema, see above)
]
}
Response Body Schema
(recursive schema, see above)
termGuid
- The globally unique identifier for glossary term.public DynamicRequest deleteGlossaryTerm(String termGuid)
termGuid
- The globally unique identifier for glossary term.public DynamicRequest partialUpdateGlossaryTerm(String termGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Request Body Schema
{
String: String
}
Response Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
abbreviation: String
templateName: [
Object
]
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
antonyms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
createTime: Float
createdBy: String
updateTime: Float
updatedBy: String
status: String(Draft/Approved/Alert/Expired)
resources: [
{
displayName: String
url: String
}
]
contacts: {
String: [
{
id: String
info: String
}
]
}
attributes: {
String: {
String: Object
}
}
assignedEntities: [
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
categories: [
{
categoryGuid: String
description: String
displayText: String
relationGuid: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
}
]
classifies: [
(recursive schema, see above)
]
examples: [
String
]
isA: [
(recursive schema, see above)
]
preferredTerms: [
(recursive schema, see above)
]
preferredToTerms: [
(recursive schema, see above)
]
replacedBy: [
(recursive schema, see above)
]
replacementTerms: [
(recursive schema, see above)
]
seeAlso: [
(recursive schema, see above)
]
synonyms: [
(recursive schema, see above)
]
translatedTerms: [
(recursive schema, see above)
]
translationTerms: [
(recursive schema, see above)
]
usage: String
validValues: [
(recursive schema, see above)
]
validValuesFor: [
(recursive schema, see above)
]
}
termGuid
- The globally unique identifier for glossary term.public DynamicRequest createGlossaryTerms()
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Request Body Schema
[
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
abbreviation: String
templateName: [
Object
]
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
antonyms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
createTime: Float
createdBy: String
updateTime: Float
updatedBy: String
status: String(Draft/Approved/Alert/Expired)
resources: [
{
displayName: String
url: String
}
]
contacts: {
String: [
{
id: String
info: String
}
]
}
attributes: {
String: {
String: Object
}
}
assignedEntities: [
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
categories: [
{
categoryGuid: String
description: String
displayText: String
relationGuid: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
}
]
classifies: [
(recursive schema, see above)
]
examples: [
String
]
isA: [
(recursive schema, see above)
]
preferredTerms: [
(recursive schema, see above)
]
preferredToTerms: [
(recursive schema, see above)
]
replacedBy: [
(recursive schema, see above)
]
replacementTerms: [
(recursive schema, see above)
]
seeAlso: [
(recursive schema, see above)
]
synonyms: [
(recursive schema, see above)
]
translatedTerms: [
(recursive schema, see above)
]
translationTerms: [
(recursive schema, see above)
]
usage: String
validValues: [
(recursive schema, see above)
]
validValuesFor: [
(recursive schema, see above)
]
}
]
Response Body Schema
[
(recursive schema, see above)
]
public DynamicRequest getEntitiesAssignedWithTerm(String termGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
[
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
termGuid
- The globally unique identifier for glossary term.public DynamicRequest assignTermToEntities(String termGuid)
Request Body Schema
[
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
termGuid
- The globally unique identifier for glossary term.public DynamicRequest removeTermAssignmentFromEntities(String termGuid)
Request Body Schema
[
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
termGuid
- The globally unique identifier for glossary term.public DynamicRequest deleteTermAssignmentFromEntities(String termGuid)
Request Body Schema
[
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
termGuid
- The globally unique identifier for glossary term.public DynamicRequest listRelatedTerms(String termGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
{
String: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
}
termGuid
- The globally unique identifier for glossary term.public DynamicRequest getGlossary(String glossaryGuid)
Response Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
categories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
language: String
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
usage: String
}
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest updateGlossary(String glossaryGuid)
Request Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
categories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
language: String
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
usage: String
}
Response Body Schema
(recursive schema, see above)
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest deleteGlossary(String glossaryGuid)
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest listGlossaryCategories(String glossaryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
[
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
childrenCategories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
parentCategory: (recursive schema, see parentCategory above)
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
}
]
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest listGlossaryCategoriesHeaders(String glossaryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
[
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest getDetailedGlossary(String glossaryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Response Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
categories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
language: String
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
usage: String
categoryInfo: {
String: {
guid: String
classifications: [
(recursive schema, see above)
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
childrenCategories: [
(recursive schema, see above)
]
parentCategory: (recursive schema, see parentCategory above)
terms: [
(recursive schema, see above)
]
}
}
termInfo: {
String: {
guid: String
classifications: [
(recursive schema, see above)
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
abbreviation: String
templateName: [
Object
]
anchor: (recursive schema, see anchor above)
antonyms: [
(recursive schema, see above)
]
createTime: Float
createdBy: String
updateTime: Float
updatedBy: String
status: String(Draft/Approved/Alert/Expired)
resources: [
{
displayName: String
url: String
}
]
contacts: {
String: [
{
id: String
info: String
}
]
}
attributes: {
String: {
String: Object
}
}
assignedEntities: [
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
categories: [
{
categoryGuid: String
description: String
displayText: String
relationGuid: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
}
]
classifies: [
(recursive schema, see above)
]
examples: [
String
]
isA: [
(recursive schema, see above)
]
preferredTerms: [
(recursive schema, see above)
]
preferredToTerms: [
(recursive schema, see above)
]
replacedBy: [
(recursive schema, see above)
]
replacementTerms: [
(recursive schema, see above)
]
seeAlso: [
(recursive schema, see above)
]
synonyms: [
(recursive schema, see above)
]
translatedTerms: [
(recursive schema, see above)
]
translationTerms: [
(recursive schema, see above)
]
usage: String
validValues: [
(recursive schema, see above)
]
validValuesFor: [
(recursive schema, see above)
]
}
}
}
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest partialUpdateGlossary(String glossaryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Request Body Schema
{
String: String
}
Response Body Schema
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
categories: [
{
categoryGuid: String
description: String
displayText: String
parentCategoryGuid: String
relationGuid: String
}
]
language: String
terms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
usage: String
}
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest listGlossaryTerms(String glossaryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
[
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
abbreviation: String
templateName: [
Object
]
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
antonyms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
createTime: Float
createdBy: String
updateTime: Float
updatedBy: String
status: String(Draft/Approved/Alert/Expired)
resources: [
{
displayName: String
url: String
}
]
contacts: {
String: [
{
id: String
info: String
}
]
}
attributes: {
String: {
String: Object
}
}
assignedEntities: [
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
categories: [
{
categoryGuid: String
description: String
displayText: String
relationGuid: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
}
]
classifies: [
(recursive schema, see above)
]
examples: [
String
]
isA: [
(recursive schema, see above)
]
preferredTerms: [
(recursive schema, see above)
]
preferredToTerms: [
(recursive schema, see above)
]
replacedBy: [
(recursive schema, see above)
]
replacementTerms: [
(recursive schema, see above)
]
seeAlso: [
(recursive schema, see above)
]
synonyms: [
(recursive schema, see above)
]
translatedTerms: [
(recursive schema, see above)
]
translationTerms: [
(recursive schema, see above)
]
usage: String
validValues: [
(recursive schema, see above)
]
validValuesFor: [
(recursive schema, see above)
]
}
]
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest listGlossaryTermHeaders(String glossaryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
sort | String | The sort order, ASC (default) or DESC. |
Response Body Schema
[
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest importGlossaryTermsViaCsv(String glossaryGuid, long contentLength)
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Request Body Schema
Flux<ByteBuffer>
Response Body Schema
{
id: String
status: String(NotStarted/Succeeded/Failed/Running)
createTime: String
lastUpdateTime: String
errorCode: Integer
errorMessage: String
importedTerms: String
totalTermsDetected: String
}
glossaryGuid
- The globally unique identifier for glossary.contentLength
- The contentLength parameter.public DynamicRequest importGlossaryTermsViaCsvByGlossaryName(String glossaryName, long contentLength)
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Request Body Schema
Flux<ByteBuffer>
Response Body Schema
{
id: String
status: String(NotStarted/Succeeded/Failed/Running)
createTime: String
lastUpdateTime: String
errorCode: Integer
errorMessage: String
importedTerms: String
totalTermsDetected: String
}
glossaryName
- The name of the glossary.contentLength
- The contentLength parameter.public DynamicRequest getImportCsvOperationStatus(String operationGuid)
Response Body Schema
{
id: String
status: String(NotStarted/Succeeded/Failed/Running)
createTime: String
lastUpdateTime: String
errorCode: Integer
errorMessage: String
importedTerms: String
totalTermsDetected: String
}
operationGuid
- The globally unique identifier for async operation/job.public DynamicRequest exportGlossaryTermsAsCsv(String glossaryGuid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermHierarchy | Boolean | Whether include term hierarchy |
Request Body Schema
[
String
]
Response Body Schema
Flux<ByteBuffer>
glossaryGuid
- The globally unique identifier for glossary.public DynamicRequest listTermsByGlossaryName(String glossaryName)
Optional Query Parameters
Name | Type | Description |
---|---|---|
limit | Integer | The page size - by default there is no paging. |
offset | Integer | The offset for pagination purpose. |
includeTermHierarchy | Boolean | Whether include term hierarchy |
Response Body Schema
[
{
guid: String
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
longDescription: String
name: String
qualifiedName: String
shortDescription: String
lastModifiedTS: String
abbreviation: String
templateName: [
Object
]
anchor: {
displayText: String
glossaryGuid: String
relationGuid: String
}
antonyms: [
{
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
createTime: Float
createdBy: String
updateTime: Float
updatedBy: String
status: String(Draft/Approved/Alert/Expired)
resources: [
{
displayName: String
url: String
}
]
contacts: {
String: [
{
id: String
info: String
}
]
}
attributes: {
String: {
String: Object
}
}
assignedEntities: [
{
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
displayText: String
entityStatus: String(ACTIVE/DELETED)
relationshipType: String
relationshipAttributes: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
}
relationshipGuid: String
relationshipStatus: String(ACTIVE/DELETED)
}
]
categories: [
{
categoryGuid: String
description: String
displayText: String
relationGuid: String
status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER)
}
]
classifies: [
(recursive schema, see above)
]
examples: [
String
]
isA: [
(recursive schema, see above)
]
preferredTerms: [
(recursive schema, see above)
]
preferredToTerms: [
(recursive schema, see above)
]
replacedBy: [
(recursive schema, see above)
]
replacementTerms: [
(recursive schema, see above)
]
seeAlso: [
(recursive schema, see above)
]
synonyms: [
(recursive schema, see above)
]
translatedTerms: [
(recursive schema, see above)
]
translationTerms: [
(recursive schema, see above)
]
usage: String
validValues: [
(recursive schema, see above)
]
validValuesFor: [
(recursive schema, see above)
]
}
]
glossaryName
- The name of the glossary.public DynamicRequest invoke()
Copyright © 2021. All rights reserved.