Azure.Analytics.Purview.DataMap (preview:2023-10-01)

2025/12/05 • 99 deleted methods

Entity_CreateOrUpdate (removed)
Description Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity
{
entity:
{
entity:
{
businessAttributes: object ,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
createTime: integer ,
createdBy: string ,
customAttributes: object ,
guid: string ,
homeId: string ,
collectionId: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
provenanceType: number ,
proxy: boolean ,
relationshipAttributes: object ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
contacts: object ,
}
,
}
,
businessAttributeUpdateBehavior: string ,
collectionId: string ,
api-version: string ,
}

⚐ Response (200)

{
guidAssignments: object ,
mutatedEntities: object ,
partialUpdatedEntities:
[
{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_ListByGuids (removed)
Description List entities in bulk identified by its GUIDs.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/entity/bulk
{
guid: array ,
minExtInfo: boolean ,
ignoreRelationships: boolean ,
api-version: string ,
}

⚐ Response (200)

{
entities:
[
{
businessAttributes: object ,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
createTime: integer ,
createdBy: string ,
customAttributes: object ,
guid: string ,
homeId: string ,
collectionId: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
provenanceType: number ,
proxy: boolean ,
relationshipAttributes: object ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
contacts: object ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_BulkCreateOrUpdate (removed)
Description Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/bulk
{
entities:
{
entities:
[
{
businessAttributes: object ,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
createTime: integer ,
createdBy: string ,
customAttributes: object ,
guid: string ,
homeId: string ,
collectionId: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
provenanceType: number ,
proxy: boolean ,
relationshipAttributes: object ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
contacts: object ,
}
,
]
,
}
,
collectionId: string ,
api-version: string ,
businessAttributeUpdateBehavior: string ,
}

⚐ Response (200)

{
guidAssignments: object ,
mutatedEntities: object ,
partialUpdatedEntities:
[
{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_BulkDelete (removed)
Description Delete a list of entities in bulk identified by their GUIDs or unique attributes.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/bulk
{
guid: array ,
}

⚐ Response (200)

{
guidAssignments: object ,
mutatedEntities: object ,
partialUpdatedEntities:
[
{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_AddClassification (removed)
Description Associate a classification to multiple entities in bulk.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/bulk/classification
{
request:
{
classification:
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
entityGuids:
[
string ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_Get (removed)
Description Get complete definition of an entity given its GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}
{
guid: string ,
minExtInfo: boolean ,
ignoreRelationships: boolean ,
}

⚐ Response (200)

{
entity:
{
businessAttributes: object ,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
createTime: integer ,
createdBy: string ,
customAttributes: object ,
guid: string ,
homeId: string ,
collectionId: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
provenanceType: number ,
proxy: boolean ,
relationshipAttributes: object ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
contacts: object ,
}
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_PartialUpdateAttributeByGuid (removed)
Description Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/entity/guid/{guid}
{
guid: string ,
name: string ,
body: object ,
}

⚐ Response (200)

{
guidAssignments: object ,
mutatedEntities: object ,
partialUpdatedEntities:
[
{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_Delete (removed)
Description Delete an entity identified by its GUID.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}
{
guid: string ,
}

⚐ Response (200)

{
guidAssignments: object ,
mutatedEntities: object ,
partialUpdatedEntities:
[
{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_GetClassification (removed)
Description Get classification for a given entity represented by a GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}/classification/{classificationName}
{
guid: string ,
classificationName: string ,
}

⚐ Response (200)

{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_RemoveClassification (removed)
Description Delete a given classification from an existing entity represented by a GUID.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/classification/{classificationName}
{
guid: string ,
classificationName: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_GetClassifications (removed)
Description List classifications for a given entity represented by a GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}/classifications
{
guid: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_AddClassifications (removed)
Description Add classifications to an existing entity represented by a GUID.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/classifications
{
guid: string ,
classifications:
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_UpdateClassifications (removed)
Description Update classifications to an existing entity represented by a guid.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/entity/guid/{guid}/classifications
{
guid: string ,
classifications:
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_GetByUniqueAttributes (removed)
Description Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/entity/uniqueAttribute/type/{typeName}
{
typeName: string ,
minExtInfo: boolean ,
ignoreRelationships: boolean ,
attr:qualifiedName: string ,
}

⚐ Response (200)

{
entity:
{
businessAttributes: object ,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
createTime: integer ,
createdBy: string ,
customAttributes: object ,
guid: string ,
homeId: string ,
collectionId: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
provenanceType: number ,
proxy: boolean ,
relationshipAttributes: object ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
contacts: object ,
}
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_PartialUpdateByUniqueAttributes (removed)
Description Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/entity/uniqueAttribute/type/{typeName}
{
typeName: string ,
attr:qualifiedName: string ,
atlasEntityWithExtInfo:
{
entity:
{
businessAttributes: object ,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
createTime: integer ,
createdBy: string ,
customAttributes: object ,
guid: string ,
homeId: string ,
collectionId: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
provenanceType: number ,
proxy: boolean ,
relationshipAttributes: object ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
contacts: object ,
}
,
}
,
}

⚐ Response (200)

{
guidAssignments: object ,
mutatedEntities: object ,
partialUpdatedEntities:
[
{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_DeleteByUniqueAttribute (removed)
Description Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\=\. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/uniqueAttribute/type/{typeName}
{
typeName: string ,
attr:qualifiedName: string ,
}

⚐ Response (200)

{
guidAssignments: object ,
mutatedEntities: object ,
partialUpdatedEntities:
[
{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_RemoveClassificationByUniqueAttribute (removed)
Description Delete a given classification from an entity identified by its type and unique attributes.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}
{
typeName: string ,
classificationName: string ,
attr:qualifiedName: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_AddClassificationsByUniqueAttribute (removed)
Description Add classification to the entity identified by its type and unique attributes.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications
{
typeName: string ,
attr:qualifiedName: string ,
atlasClassificationArray:
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_UpdateClassificationsByUniqueAttribute (removed)
Description Update classification on an entity identified by its type and unique attributes.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications
{
typeName: string ,
attr:qualifiedName: string ,
atlasClassificationArray:
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_BulkSetClassifications (removed)
Description Set classifications on entities in bulk.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/bulk/setClassifications
{
entityHeaders:
{
guidHeaderMap: object ,
}
,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_ListByUniqueAttributes (removed)
Description Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format typeName=\&attr_1:\=\&attr_2:\=\&attr_3:\=\ NOTE: The attrName should be an unique attribute for the given entity-type The REST request would look something like this GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}
{
typeName: string ,
minExtInfo: boolean ,
ignoreRelationships: boolean ,
attr_N:qualifiedName: string ,
}

⚐ Response (200)

{
entities:
[
{
businessAttributes: object ,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
createTime: integer ,
createdBy: string ,
customAttributes: object ,
guid: string ,
homeId: string ,
collectionId: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
provenanceType: number ,
proxy: boolean ,
relationshipAttributes: object ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
contacts: object ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_GetHeader (removed)
Description Get entity header given its GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}/header
{
guid: string ,
}

⚐ Response (200)

{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_RemoveBusinessMetadata (removed)
Description Remove business metadata from an entity.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/businessmetadata
{
guid: string ,
businessMetadata: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_AddOrUpdateBusinessMetadata (removed)
Description Add business metadata to an entity.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/businessmetadata
{
guid: string ,
isOverwrite: boolean ,
businessMetadata: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_RemoveBusinessMetadataAttributes (removed)
Description Delete business metadata attributes from an entity.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}
{
bmName: string ,
guid: string ,
businessMetadataAttributes: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_AddOrUpdateBusinessMetadataAttributes (removed)
Description Add or update business metadata attributes
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}
{
bmName: string ,
guid: string ,
businessMetadataAttributes: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_GetSampleBusinessMetadataTemplate (removed)
Description Get the sample Template for uploading/creating bulk BusinessMetaData
Reference Link ¶

⚼ Request

GET:  /atlas/v2/entity/businessmetadata/import/template
{}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_ImportBusinessMetadata (removed)
Description Upload the file for creating Business Metadata in BULK
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/businessmetadata/import
{
uploadedInputStream: file ,
}

⚐ Response (200)

{
failedImportInfoList:
[
{
childObjectName: string ,
importStatus: enum ,
parentObjectName: string ,
remarks: string ,
}
,
]
,
successImportInfoList:
[
{
childObjectName: string ,
importStatus: enum ,
parentObjectName: string ,
remarks: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_RemoveLabels (removed)
Description delete given labels to a given entity
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/labels
{
guid: string ,
body: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_SetLabels (removed)
Description Set labels to a given entity
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/labels
{
guid: string ,
body: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_AddLabel (removed)
Description add given labels to a given entity
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/entity/guid/{guid}/labels
{
guid: string ,
body: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_RemoveLabelsByUniqueAttribute (removed)
Description Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels
{
typeName: string ,
attr:qualifiedName: string ,
body: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_SetLabelsByUniqueAttribute (removed)
Description Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels
{
typeName: string ,
attr:qualifiedName: string ,
body: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_AddLabelsByUniqueAttribute (removed)
Description Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels
{
typeName: string ,
attr:qualifiedName: string ,
body: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_MoveEntitiesToCollection (removed)
Description Move existing entities to the target collection.
Reference Link ¶

⚼ Request

POST:  /entity/moveTo
{
collectionId: string ,
api-version: string ,
moveEntitiesRequest:
{
entityGuids:
[
string ,
]
,
}
,
}

⚐ Response (200)

{
guidAssignments: object ,
mutatedEntities: object ,
partialUpdatedEntities:
[
{
classificationNames:
[
string ,
]
,
classifications:
[
{
entityGuid: string ,
entityStatus: enum ,
removePropagationsOnEntityDelete: boolean ,
validityPeriods:
[
{
endTime: string ,
startTime: string ,
timeZone: string ,
}
,
]
,
}
,
]
,
displayText: string ,
guid: string ,
isIncomplete: boolean ,
labels:
[
string ,
]
,
meaningNames:
[
string ,
]
,
meanings:
[
{
confidence: integer ,
createdBy: string ,
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_DeleteWithHierarchy (removed)
Description Delete entities with hierarchy
Reference Link ¶

⚼ Request

DELETE:  /entity/bulk/delete
{
guid: array ,
parallelCount: string ,
api-version: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Entity_GetOperationStatus (removed)
Description Get the status of entity long running operation
Reference Link ¶

⚼ Request

GET:  /entity/operations/{operationId}
{
operationId: string ,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
status: enum ,
createTime: string ,
lastUpdateTime: string ,
properties: object ,
error:
{
code: string ,
message: string ,
}
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_List (removed)
Description Get all glossaries. Recommend using limit/offset to get pagination result. Recommended using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary
{
limit: integer ,
offset: integer ,
sort: string ,
ignoreTermsAndCategories: boolean ,
api-version: string ,
}

⚐ Response (200)

{
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
language: string ,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_Create (removed)
Description Create a glossary.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/glossary
{
atlasGlossary:
{
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
language: string ,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
}
,
}

⚐ Response (200)

{
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
language: string ,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_CreateCategories (removed)
Description Create glossary category in bulk.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/glossary/categories
{
glossaryCategory:
{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_CreateCategory (removed)
Description Create a glossary category.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/glossary/category
{
glossaryCategory:
{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_GetCategory (removed)
Description Get specific glossary category by its GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/category/{categoryGuid}
{
categoryGuid: string ,
}

⚐ Response (200)

{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_UpdateCategory (removed)
Description Update the given glossary category by its GUID.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/category/{categoryGuid}
{
categoryGuid: string ,
glossaryCategory:
{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_DeleteCategory (removed)
Description Delete a glossary category.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/category/{categoryGuid}
{
categoryGuid: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_PartialUpdateCategory (removed)
Description Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/category/{categoryGuid}/partial
{
categoryGuid: string ,
partialUpdates: object ,
}

⚐ Response (200)

{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_ListRelatedCategories (removed)
Description Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/category/{categoryGuid}/related
{
categoryGuid: string ,
limit: integer ,
offset: integer ,
sort: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_ListCategoryTerms (removed)
Description Get all terms associated with the specific category.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/category/{categoryGuid}/terms
{
categoryGuid: string ,
limit: integer ,
offset: integer ,
sort: string ,
}

⚐ Response (200)

{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_CreateTerm (removed)
Description Create a glossary term.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/glossary/term
{
glossaryTerm:
{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}
,
includeTermHierarchy: boolean ,
}

⚐ Response (200)

{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_GetTerm (removed)
Description Get a specific glossary term by its GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/term/{termGuid}
{
api-version: string ,
termGuid: string ,
}

⚐ Response (200)

{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_UpdateTerm (removed)
Description Update the given glossary term by its GUID.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/term/{termGuid}
{
api-version: string ,
termGuid: string ,
glossaryTerm:
{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}
,
includeTermHierarchy: boolean ,
}

⚐ Response (200)

{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_DeleteTerm (removed)
Description Delete a glossary term.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/term/{termGuid}
{
termGuid: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_PartialUpdateTerm (removed)
Description Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/term/{termGuid}/partial
{
api-version: string ,
termGuid: string ,
includeTermHierarchy: boolean ,
partialUpdates: object ,
}

⚐ Response (200)

{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_CreateTerms (removed)
Description Create glossary terms in bulk.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/glossary/terms
{
api-version: string ,
glossaryTerm:
{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}
,
includeTermHierarchy: boolean ,
}

⚐ Response (200)

{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_ListEntitiesAssignedWithTerm (removed)
Description List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/terms/{termGuid}/assignedEntities
{
termGuid: string ,
limit: integer ,
offset: integer ,
sort: string ,
}

⚐ Response (200)

{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_AssignTermToEntities (removed)
Description Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/glossary/terms/{termGuid}/assignedEntities
{
termGuid: string ,
relatedObjectIds:
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_DeleteTermAssignmentFromEntities (removed)
Description Delete the term assignment for the given list of related objects.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/terms/{termGuid}/assignedEntities
{
termGuid: string ,
relatedObjectIds:
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_ListRelatedTerms (removed)
Description Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/terms/{termGuid}/related
{
api-version: string ,
termGuid: string ,
limit: integer ,
offset: integer ,
sort: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_Get (removed)
Description Get a specific Glossary by its GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}
{
glossaryGuid: string ,
}

⚐ Response (200)

{
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
language: string ,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_Update (removed)
Description Update the given glossary.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/{glossaryGuid}
{
api-version: string ,
glossaryGuid: string ,
ignoreTermsAndCategories: boolean ,
updatedGlossary:
{
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
language: string ,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
}
,
}

⚐ Response (200)

{
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
language: string ,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_Delete (removed)
Description Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/{glossaryGuid}
{
glossaryGuid: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_ListCategories (removed)
Description Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/categories
{
glossaryGuid: string ,
limit: integer ,
offset: integer ,
sort: string ,
}

⚐ Response (200)

{
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
childrenCategories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
parentCategory:
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_ListCategoriesHeaders (removed)
Description Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/categories/headers
{
glossaryGuid: string ,
limit: integer ,
offset: integer ,
sort: string ,
}

⚐ Response (200)

{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_GetDetailed (removed)
Description Get a specific glossary with detailed information. This API is not recommend. Recommended fetch terms/categories details separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/detailed
{
api-version: string ,
glossaryGuid: string ,
}

⚐ Response (200)

{
categoryInfo: object ,
termInfo: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_PartialUpdate (removed)
Description Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/{glossaryGuid}/partial
{
api-version: string ,
glossaryGuid: string ,
ignoreTermsAndCategories: boolean ,
partialUpdates: object ,
}

⚐ Response (200)

{
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
parentCategoryGuid: string ,
relationGuid: string ,
}
,
]
,
language: string ,
terms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_ListTerms (removed)
Description Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/terms
{
api-version: string ,
glossaryGuid: string ,
limit: integer ,
offset: integer ,
sort: string ,
}

⚐ Response (200)

{
abbreviation: string ,
templateName:
[
object ,
]
,
anchor:
{
displayText: string ,
glossaryGuid: string ,
relationGuid: string ,
}
,
antonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
status: enum ,
nickName: string ,
hierarchyInfo:
[
{
name: string ,
displayText: string ,
itemPath: string ,
resourceId: string ,
properties: object ,
}
,
]
,
resources:
[
{
displayName: string ,
url: string ,
}
,
]
,
contacts: object ,
attributes: object ,
assignedEntities:
[
{
displayText: string ,
entityStatus: enum ,
relationshipType: string ,
relationshipAttributes:
{
attributes: object ,
typeName: string ,
lastModifiedTS: string ,
}
,
relationshipGuid: string ,
relationshipStatus: enum ,
}
,
]
,
categories:
[
{
categoryGuid: string ,
description: string ,
displayText: string ,
relationGuid: string ,
status: enum ,
}
,
]
,
classifies:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
examples:
[
string ,
]
,
isA:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
preferredToTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacedBy:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
replacementTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
seeAlso:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
synonyms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translatedTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
translationTerms:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
usage: string ,
validValues:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
validValuesFor:
[
{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Glossary_ListTermHeaders (removed)
Description Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/terms/headers
{
glossaryGuid: string ,
limit: integer ,
offset: integer ,
sort: string ,
}

⚐ Response (200)

{
description: string ,
displayText: string ,
expression: string ,
relationGuid: string ,
status: enum ,
steward: string ,
termGuid: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Discovery_Query (removed)
Description Gets data using search.
Reference Link ¶

⚼ Request

POST:  /search/query
{
searchRequest:
{
keywords: string ,
limit: integer ,
continuationToken: string ,
orderby:
[
object ,
]
,
filter: object ,
facets:
[
{
count: integer ,
facet: string ,
sort: object ,
}
,
]
,
taxonomySetting:
{
assetTypes:
[
string ,
]
,
facet:
{
count: integer ,
facet: string ,
sort: object ,
}
,
}
,
}
,
api-version: string ,
}

⚐ Response (200)

{
@search.count: integer ,
@search.count.approximate: boolean ,
continuationToken: string ,
@search.facets:
{
entityType:
[
{
count: integer ,
value: string ,
}
,
]
,
assetType:
[
{
count: integer ,
value: string ,
}
,
]
,
classification:
[
{
count: integer ,
value: string ,
}
,
]
,
term:
[
{
count: integer ,
value: string ,
}
,
]
,
contactId:
[
{
count: integer ,
value: string ,
}
,
]
,
contactType:
[
{
count: integer ,
value: string ,
}
,
]
,
label:
[
{
count: integer ,
value: string ,
}
,
]
,
glossaryType:
[
{
count: integer ,
value: string ,
}
,
]
,
termStatus:
[
{
count: integer ,
value: string ,
}
,
]
,
termTemplate:
[
{
count: integer ,
value: string ,
}
,
]
,
}
,
value:
[
{
@search.score: number ,
@search.highlights:
{
id:
[
string ,
]
,
qualifiedName:
[
string ,
]
,
name:
[
string ,
]
,
description:
[
string ,
]
,
entityType:
[
string ,
]
,
}
,
objectType: string ,
createTime: integer ,
updateTime: integer ,
id: string ,
name: string ,
qualifiedName: string ,
entityType: string ,
description: string ,
endorsement:
[
string ,
]
,
owner: string ,
classification:
[
string ,
]
,
label:
[
string ,
]
,
term:
[
{
name: string ,
glossaryName: string ,
guid: string ,
}
,
]
,
contact:
[
{
id: string ,
info: string ,
contactType: string ,
}
,
]
,
assetType:
[
string ,
]
,
glossaryType: string ,
glossary: string ,
termStatus: string ,
termTemplate:
[
string ,
]
,
longDescription: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Discovery_Suggest (removed)
Description Get search suggestions by query criteria.
Reference Link ¶

⚼ Request

POST:  /search/suggest
{
suggestRequest:
{
keywords: string ,
limit: integer ,
filter: object ,
}
,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
@search.score: number ,
@search.text: string ,
objectType: string ,
createTime: integer ,
updateTime: integer ,
id: string ,
name: string ,
qualifiedName: string ,
entityType: string ,
description: string ,
endorsement:
[
string ,
]
,
owner: string ,
classification:
[
string ,
]
,
label:
[
string ,
]
,
term:
[
{
name: string ,
glossaryName: string ,
guid: string ,
}
,
]
,
contact:
[
{
id: string ,
info: string ,
contactType: string ,
}
,
]
,
assetType:
[
string ,
]
,
glossaryType: string ,
glossary: string ,
termStatus: string ,
termTemplate:
[
string ,
]
,
longDescription: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Discovery_AutoComplete (removed)
Description Get auto complete options.
Reference Link ¶

⚼ Request

POST:  /search/autocomplete
{
autoCompleteRequest:
{
keywords: string ,
limit: integer ,
filter: object ,
}
,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
text: string ,
queryPlusText: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Lineage_Get (removed)
Description Get lineage info of the entity specified by GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/lineage/{guid}
{
guid: string ,
depth: integer ,
direction: string ,
}

⚐ Response (200)

{
baseEntityGuid: string ,
guidEntityMap: object ,
widthCounts: object ,
lineageDepth: integer ,
lineageWidth: integer ,
childrenCount: integer ,
lineageDirection: enum ,
parentRelations:
[
{
childEntityId: string ,
relationshipId: string ,
parentEntityId: string ,
}
,
]
,
relations:
[
{
fromEntityId: string ,
relationshipId: string ,
toEntityId: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Lineage_GetNextPage (removed)
Description Return immediate next page lineage info about entity with pagination
Reference Link ¶

⚼ Request

GET:  /lineage/{guid}/next/
{
guid: string ,
direction: string ,
offset: integer ,
limit: integer ,
api-version: string ,
}

⚐ Response (200)

{
baseEntityGuid: string ,
guidEntityMap: object ,
widthCounts: object ,
lineageDepth: integer ,
lineageWidth: integer ,
childrenCount: integer ,
lineageDirection: enum ,
parentRelations:
[
{
childEntityId: string ,
relationshipId: string ,
parentEntityId: string ,
}
,
]
,
relations:
[
{
fromEntityId: string ,
relationshipId: string ,
toEntityId: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Lineage_GetByUniqueAttribute (removed)
Description Returns lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format attr:[attrName]=[attrValue] NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/lineage/uniqueAttribute/type/{typeName}
{
typeName: string ,
depth: integer ,
direction: string ,
attr:qualifiedName: string ,
}

⚐ Response (200)

{
baseEntityGuid: string ,
guidEntityMap: object ,
widthCounts: object ,
lineageDepth: integer ,
lineageWidth: integer ,
childrenCount: integer ,
lineageDirection: enum ,
parentRelations:
[
{
childEntityId: string ,
relationshipId: string ,
parentEntityId: string ,
}
,
]
,
relations:
[
{
fromEntityId: string ,
relationshipId: string ,
toEntityId: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Relationship_Create (removed)
Description Create a new relationship between entities.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/relationship
{
relationship:
{
createTime: integer ,
createdBy: string ,
end1:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
end2:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
guid: string ,
homeId: string ,
label: string ,
provenanceType: number ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
}
,
}

⚐ Response (200)

{
createTime: integer ,
createdBy: string ,
end1:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
end2:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
guid: string ,
homeId: string ,
label: string ,
provenanceType: number ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Relationship_Update (removed)
Description Update an existing relationship between entities.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/relationship
{
relationship:
{
createTime: integer ,
createdBy: string ,
end1:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
end2:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
guid: string ,
homeId: string ,
label: string ,
provenanceType: number ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
}
,
}

⚐ Response (200)

{
createTime: integer ,
createdBy: string ,
end1:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
end2:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
guid: string ,
homeId: string ,
label: string ,
provenanceType: number ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Relationship_Get (removed)
Description Get relationship information between entities by its GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/relationship/guid/{guid}
{
guid: string ,
extendedInfo: boolean ,
}

⚐ Response (200)

{
referredEntities: object ,
relationship:
{
createTime: integer ,
createdBy: string ,
end1:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
end2:
{
guid: string ,
typeName: string ,
uniqueAttributes: object ,
}
,
guid: string ,
homeId: string ,
label: string ,
provenanceType: number ,
status: enum ,
updateTime: integer ,
updatedBy: string ,
version: number ,
}
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Relationship_Delete (removed)
Description Delete a relationship between entities by its GUID.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/relationship/guid/{guid}
{
guid: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetBusinessMetadataDefByGuid (removed)
Description Get the businessMetadata definition for the given guid
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/businessmetadatadef/guid/{guid}
{
guid: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetBusinessMetadataDefByName (removed)
Description Get the businessMetadata definition by it's name (unique)
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/businessmetadatadef/name/{name}
{
name: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetClassificationDefByGuid (removed)
Description Get the classification definition for the given GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/classificationdef/guid/{guid}
{
guid: string ,
}

⚐ Response (200)

{
entityTypes:
[
string ,
]
,
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetClassificationDefByName (removed)
Description Get the classification definition by its name (unique).
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/classificationdef/name/{name}
{
name: string ,
}

⚐ Response (200)

{
entityTypes:
[
string ,
]
,
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetEntityDefByGuid (removed)
Description Get the Entity definition for the given GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/entitydef/guid/{guid}
{
guid: string ,
}

⚐ Response (200)

{
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
relationshipAttributeDefs:
[
{
isLegacyAttribute: boolean ,
relationshipTypeName: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetEntityDefByName (removed)
Description Get the entity definition by its name (unique).
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/entitydef/name/{name}
{
name: string ,
}

⚐ Response (200)

{
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
relationshipAttributeDefs:
[
{
isLegacyAttribute: boolean ,
relationshipTypeName: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetEnumDefByGuid (removed)
Description Get the enum definition for the given GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/enumdef/guid/{guid}
{
guid: string ,
}

⚐ Response (200)

{
defaultValue: string ,
elementDefs:
[
{
description: string ,
ordinal: number ,
value: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetEnumDefByName (removed)
Description Get the enum definition by its name (unique).
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/enumdef/name/{name}
{
name: string ,
}

⚐ Response (200)

{
defaultValue: string ,
elementDefs:
[
{
description: string ,
ordinal: number ,
value: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetRelationshipDefByGuid (removed)
Description Get the relationship definition for the given GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/relationshipdef/guid/{guid}
{
guid: string ,
}

⚐ Response (200)

{
endDef1:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
endDef2:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
relationshipCategory: enum ,
relationshipLabel: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetRelationshipDefByName (removed)
Description Get the relationship definition by its name (unique).
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/relationshipdef/name/{name}
{
name: string ,
}

⚐ Response (200)

{
endDef1:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
endDef2:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
relationshipCategory: enum ,
relationshipLabel: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetStructDefByGuid (removed)
Description Get the struct definition for the given GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/structdef/guid/{guid}
{
guid: string ,
}

⚐ Response (200)

{
attributeDefs:
[
{
cardinality: enum ,
constraints:
[
{
params: object ,
type: string ,
}
,
]
,
defaultValue: string ,
description: string ,
includeInNotification: boolean ,
isIndexable: boolean ,
isOptional: boolean ,
isUnique: boolean ,
name: string ,
options: object ,
typeName: string ,
valuesMaxCount: integer ,
valuesMinCount: integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetStructDefByName (removed)
Description Get the struct definition by its name (unique).
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/structdef/name/{name}
{
name: string ,
}

⚐ Response (200)

{
attributeDefs:
[
{
cardinality: enum ,
constraints:
[
{
params: object ,
type: string ,
}
,
]
,
defaultValue: string ,
description: string ,
includeInNotification: boolean ,
isIndexable: boolean ,
isOptional: boolean ,
isUnique: boolean ,
name: string ,
options: object ,
typeName: string ,
valuesMaxCount: integer ,
valuesMinCount: integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetByGuid (removed)
Description Get the type definition for the given GUID.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/typedef/guid/{guid}
{
guid: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetByName (removed)
Description Get the type definition by its name (unique).
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/typedef/name/{name}
{
name: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_Delete (removed)
Description Delete API for type identified by its name.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/types/typedef/name/{name}
{
name: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_List (removed)
Description List all type definitions in bulk.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/typedefs
{
includeTermTemplate: boolean ,
type: string ,
api-version: string ,
}

⚐ Response (200)

{
businessMetadataDefs:
[
object ,
]
,
classificationDefs:
[
{
entityTypes:
[
string ,
]
,
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
}
,
]
,
entityDefs:
[
{
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
relationshipAttributeDefs:
[
{
isLegacyAttribute: boolean ,
relationshipTypeName: string ,
}
,
]
,
}
,
]
,
enumDefs:
[
{
defaultValue: string ,
elementDefs:
[
{
description: string ,
ordinal: number ,
value: string ,
}
,
]
,
}
,
]
,
relationshipDefs:
[
{
endDef1:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
endDef2:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
relationshipCategory: enum ,
relationshipLabel: string ,
}
,
]
,
structDefs:
[
{
attributeDefs:
[
{
cardinality: enum ,
constraints:
[
{
params: object ,
type: string ,
}
,
]
,
defaultValue: string ,
description: string ,
includeInNotification: boolean ,
isIndexable: boolean ,
isOptional: boolean ,
isUnique: boolean ,
name: string ,
options: object ,
typeName: string ,
valuesMaxCount: integer ,
valuesMinCount: integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
[
object ,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_BulkCreate (removed)
Description Create all atlas type definitions in bulk. Please avoid recreating existing types.
Reference Link ¶

⚼ Request

POST:  /atlas/v2/types/typedefs
{
typesDef:
{
businessMetadataDefs:
[
object ,
]
,
classificationDefs:
[
{
entityTypes:
[
string ,
]
,
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
}
,
]
,
entityDefs:
[
{
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
relationshipAttributeDefs:
[
{
isLegacyAttribute: boolean ,
relationshipTypeName: string ,
}
,
]
,
}
,
]
,
enumDefs:
[
{
defaultValue: string ,
elementDefs:
[
{
description: string ,
ordinal: number ,
value: string ,
}
,
]
,
}
,
]
,
relationshipDefs:
[
{
endDef1:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
endDef2:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
relationshipCategory: enum ,
relationshipLabel: string ,
}
,
]
,
structDefs:
[
{
attributeDefs:
[
{
cardinality: enum ,
constraints:
[
{
params: object ,
type: string ,
}
,
]
,
defaultValue: string ,
description: string ,
includeInNotification: boolean ,
isIndexable: boolean ,
isOptional: boolean ,
isUnique: boolean ,
name: string ,
options: object ,
typeName: string ,
valuesMaxCount: integer ,
valuesMinCount: integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
[
object ,
]
,
}
,
}

⚐ Response (200)

{
businessMetadataDefs:
[
object ,
]
,
classificationDefs:
[
{
entityTypes:
[
string ,
]
,
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
}
,
]
,
entityDefs:
[
{
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
relationshipAttributeDefs:
[
{
isLegacyAttribute: boolean ,
relationshipTypeName: string ,
}
,
]
,
}
,
]
,
enumDefs:
[
{
defaultValue: string ,
elementDefs:
[
{
description: string ,
ordinal: number ,
value: string ,
}
,
]
,
}
,
]
,
relationshipDefs:
[
{
endDef1:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
endDef2:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
relationshipCategory: enum ,
relationshipLabel: string ,
}
,
]
,
structDefs:
[
{
attributeDefs:
[
{
cardinality: enum ,
constraints:
[
{
params: object ,
type: string ,
}
,
]
,
defaultValue: string ,
description: string ,
includeInNotification: boolean ,
isIndexable: boolean ,
isOptional: boolean ,
isUnique: boolean ,
name: string ,
options: object ,
typeName: string ,
valuesMaxCount: integer ,
valuesMinCount: integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
[
object ,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_BulkUpdate (removed)
Description Update all types in bulk, changes detected in the type definitions would be persisted.
Reference Link ¶

⚼ Request

PUT:  /atlas/v2/types/typedefs
{
typesDef:
{
businessMetadataDefs:
[
object ,
]
,
classificationDefs:
[
{
entityTypes:
[
string ,
]
,
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
}
,
]
,
entityDefs:
[
{
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
relationshipAttributeDefs:
[
{
isLegacyAttribute: boolean ,
relationshipTypeName: string ,
}
,
]
,
}
,
]
,
enumDefs:
[
{
defaultValue: string ,
elementDefs:
[
{
description: string ,
ordinal: number ,
value: string ,
}
,
]
,
}
,
]
,
relationshipDefs:
[
{
endDef1:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
endDef2:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
relationshipCategory: enum ,
relationshipLabel: string ,
}
,
]
,
structDefs:
[
{
attributeDefs:
[
{
cardinality: enum ,
constraints:
[
{
params: object ,
type: string ,
}
,
]
,
defaultValue: string ,
description: string ,
includeInNotification: boolean ,
isIndexable: boolean ,
isOptional: boolean ,
isUnique: boolean ,
name: string ,
options: object ,
typeName: string ,
valuesMaxCount: integer ,
valuesMinCount: integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
[
object ,
]
,
}
,
}

⚐ Response (200)

{
businessMetadataDefs:
[
object ,
]
,
classificationDefs:
[
{
entityTypes:
[
string ,
]
,
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
}
,
]
,
entityDefs:
[
{
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
relationshipAttributeDefs:
[
{
isLegacyAttribute: boolean ,
relationshipTypeName: string ,
}
,
]
,
}
,
]
,
enumDefs:
[
{
defaultValue: string ,
elementDefs:
[
{
description: string ,
ordinal: number ,
value: string ,
}
,
]
,
}
,
]
,
relationshipDefs:
[
{
endDef1:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
endDef2:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
relationshipCategory: enum ,
relationshipLabel: string ,
}
,
]
,
structDefs:
[
{
attributeDefs:
[
{
cardinality: enum ,
constraints:
[
{
params: object ,
type: string ,
}
,
]
,
defaultValue: string ,
description: string ,
includeInNotification: boolean ,
isIndexable: boolean ,
isOptional: boolean ,
isUnique: boolean ,
name: string ,
options: object ,
typeName: string ,
valuesMaxCount: integer ,
valuesMinCount: integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
[
object ,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_BulkDelete (removed)
Description Delete API for all types in bulk.
Reference Link ¶

⚼ Request

DELETE:  /atlas/v2/types/typedefs
{
typesDef:
{
businessMetadataDefs:
[
object ,
]
,
classificationDefs:
[
{
entityTypes:
[
string ,
]
,
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
}
,
]
,
entityDefs:
[
{
subTypes:
[
string ,
]
,
superTypes:
[
string ,
]
,
relationshipAttributeDefs:
[
{
isLegacyAttribute: boolean ,
relationshipTypeName: string ,
}
,
]
,
}
,
]
,
enumDefs:
[
{
defaultValue: string ,
elementDefs:
[
{
description: string ,
ordinal: number ,
value: string ,
}
,
]
,
}
,
]
,
relationshipDefs:
[
{
endDef1:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
endDef2:
{
cardinality: enum ,
description: string ,
isContainer: boolean ,
isLegacyAttribute: boolean ,
name: string ,
type: string ,
}
,
relationshipCategory: enum ,
relationshipLabel: string ,
}
,
]
,
structDefs:
[
{
attributeDefs:
[
{
cardinality: enum ,
constraints:
[
{
params: object ,
type: string ,
}
,
]
,
defaultValue: string ,
description: string ,
includeInNotification: boolean ,
isIndexable: boolean ,
isOptional: boolean ,
isUnique: boolean ,
name: string ,
options: object ,
typeName: string ,
valuesMaxCount: integer ,
valuesMinCount: integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
[
object ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_ListHeaders (removed)
Description List all type definitions returned as a list of minimal information header.
Reference Link ¶

⚼ Request

GET:  /atlas/v2/types/typedefs/headers
{
includeTermTemplate: boolean ,
type: string ,
api-version: string ,
}

⚐ Response (200)

{
category: enum ,
guid: string ,
name: string ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetTermTemplateDefByGuid (removed)
Description Get the term template definition for the given GUID.
Reference Link ¶

⚼ Request

GET:  /types/termtemplatedef/guid/{guid}
{
guid: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Type_GetTermTemplateDefByName (removed)
Description Get the term template definition by its name (unique).
Reference Link ¶

⚼ Request

GET:  /types/termtemplatedef/name/{name}
{
name: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}
Audit_Query (removed)
Description Query audit logs for an asset, glossaryTerm, classificationDef, etc.
Reference Link ¶

⚼ Request

POST:  /audit/query
{
auditLogQueryRequest:
{
category: enum ,
guid: string ,
typeName: string ,
qualifiedName: string ,
operationType: enum ,
userId: string ,
keywords: string ,
startTime: string ,
endTime: string ,
sortBy: string ,
sortOrder: enum ,
pageSize: integer ,
continuationToken: string ,
}
,
api-version: string ,
}

⚐ Response (200)

{
continuationToken: string ,
lastPage: boolean ,
totalResultCount: integer ,
recordCount: integer ,
resultData:
[
{
workload: string ,
recordType: integer ,
id: string ,
creationTime: string ,
operation: enum ,
organizationId: string ,
userType: integer ,
userKey: string ,
userId: string ,
clientIP: string ,
accountId: string ,
catalogId: string ,
changeRequestId: string ,
cloudType: string ,
serviceType: string ,
objectId: string ,
objectName: string ,
objectFullyQualifiedName: string ,
objectType: string ,
objectCollectionId: string ,
oldValue: string ,
newValue: string ,
}
,
]
,
}

⚐ Response (default)

{
requestId: string ,
errorCode: string ,
errorMessage: string ,
}