Azure.Analytics.Purview.Catalog (preview:2022-08-01)

2025/12/05 • 107 deleted methods

Entity_CreateOrUpdate (removed)
Description :  Create or update an entity in Atlas. 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:
{
Description: Atlas entity with extended information. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_ListByGuids (removed)
Description :  List entities in bulk identified by its GUIDs.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/bulk
{
guid:
{
Description: An array of GUIDs of entities to list. ,
Required: True ,
}
array ,
minExtInfo:
{
Description: Whether to return minimal information for referred entities. ,
Required: False ,
}
boolean ,
ignoreRelationships:
{
Description: Whether to ignore relationship attributes. ,
Required: False ,
}
boolean ,
excludeRelationshipTypes:
{
Description: An array of the relationship types need to be excluded from the response. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$schema:
{
Description: An instance of an entity along with extended info - like hive_table, hive_database. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_CreateOrUpdateEntities (removed)
Description :  Create or update entities in Atlas 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:
{
Description: An array of entities to create or update. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteByGuids (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:
{
Description: An array of GUIDs of entities to delete. ,
Required: True ,
}
array ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddClassification (removed)
Description :  Associate a classification to multiple entities in bulk.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/bulk/classification
{
request:
{
Description: The request to associate a classification to multiple entities. ,
Required: True ,
}
{
classification:
{
Description: An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. ,
Required: False ,
}
object ,
entityGuids:
{
Description: The GUID of the entity. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetByGuid (removed)
Description :  Get complete definition of an entity given its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
minExtInfo:
{
Description: Whether to return minimal information for referred entities. ,
Required: False ,
}
boolean ,
ignoreRelationships:
{
Description: Whether to ignore relationship attributes. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: An instance of an entity along with extended info - like hive_table, hive_database. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_PartialUpdateEntityAttributeByGuid (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:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
name:
{
Description: The name of the attribute. ,
Required: True ,
}
string ,
body:
{
Description: The value of the attribute. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteByGuid (removed)
Description :  Delete an entity identified by its GUID.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetClassification (removed)
Description :  List classifications for a given entity represented by a GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}/classification/{classificationName}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
classificationName:
{
Description: The name of the classification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteClassification (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:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
classificationName:
{
Description: The name of the classification. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: REST serialization friendly list. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
classifications:
{
Description: An array of classifications to be added. ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
classifications:
{
Description: An array of classifications to be updated. ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
minExtInfo:
{
Description: Whether to return minimal information for referred entities. ,
Required: False ,
}
boolean ,
ignoreRelationships:
{
Description: Whether to ignore relationship attributes. ,
Required: False ,
}
boolean ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An instance of an entity along with extended info - like hive_table, hive_database. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_PartialUpdateEntityByUniqueAttributes (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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
atlasEntityWithExtInfo:
{
Description: Atlas entity with extended information. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteClassificationByUniqueAttribute (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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
classificationName:
{
Description: The name of the classification. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
atlasClassificationArray:
{
Description: An array of classification to be added. ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
atlasClassificationArray:
{
Description: An array of classification to be updated. ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_SetClassifications (removed)
Description :  Set classifications on entities in bulk.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/bulk/setClassifications
{
entityHeaders:
{
Description: Atlas entity headers. ,
Required: True ,
}
{
guidHeaderMap:
{
Description: The description of the guid header map, ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Response that indicates each classification mutation result. ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetEntitiesByUniqueAttributes (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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
minExtInfo:
{
Description: Whether to return minimal information for referred entities. ,
Required: False ,
}
boolean ,
ignoreRelationships:
{
Description: Whether to ignore relationship attributes. ,
Required: False ,
}
boolean ,
attr_N:qualifiedName:
{
Description: Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An instance of an entity along with extended info - like hive_table, hive_database. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetHeader (removed)
Description :  Get entity header given its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}/header
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An instance of an entity - like hive_table, hive_database. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteBusinessMetadata (removed)
Description :  Remove business metadata from an entity.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/businessmetadata
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: BusinessMetadata ,
Required: False ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddOrUpdateBusinessMetadata (removed)
Description :  Add business metadata to an entity.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/businessmetadata
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
isOverwrite:
{
Description: Whether to overwrite the existing business metadata on the entity or not, default is false. ,
Required: False ,
}
boolean ,
body:
{
Description: Business Metadata ,
Required: False ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteBusinessMetadataAttributes (removed)
Description :  Delete business metadata attributes from an entity.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}
{
bmName:
{
Description: BusinessMetadata name ,
Required: True ,
}
string ,
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: BusinessMetadataAttributes ,
Required: False ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddOrUpdateBusinessMetadataAttributes (removed)
Description :  Add or update business metadata attributes
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}
{
bmName:
{
Description: BusinessMetadata name ,
Required: True ,
}
string ,
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: BusinessMetadataAttributes ,
Required: False ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: Template File ,
}
file ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_ImportBusinessMetadata (removed)
Description :  Upload the file for creating Business Metadata in BULK
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/businessmetadata/import
{
uploadedInputStream:
{
Description: InputStream of file ,
Required: False ,
}
file ,
}

⚐ Response (200)

{
failedImportInfoList:
{
Description: failed importInfoList ,
Required: False ,
}
[
{
childObjectName:
{
Description: childObjectName ,
Required: False ,
}
string ,
importStatus:
{
Description: importStatus ,
Enum:
{
SUCCESS: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
parentObjectName:
{
Description: parentObjectName ,
Required: False ,
}
string ,
remarks:
{
Description: remarks ,
Required: False ,
}
string ,
}
,
]
,
successImportInfoList:
{
Description: successful importInfoList ,
Required: False ,
}
[
{
childObjectName:
{
Description: childObjectName ,
Required: False ,
}
string ,
importStatus:
{
Description: importStatus ,
Enum:
{
SUCCESS: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
parentObjectName:
{
Description: parentObjectName ,
Required: False ,
}
string ,
remarks:
{
Description: remarks ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteLabels (removed)
Description :  delete given labels to a given entity
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/labels
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: set of labels to be deleted ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_SetLabels (removed)
Description :  Set labels to a given entity
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/labels
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: set of labels to be set to the entity ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddLabel (removed)
Description :  add given labels to a given entity
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/entity/guid/{guid}/labels
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: set of labels to be added ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteLabelsByUniqueAttribute (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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Description: set of labels to be deleted ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Description: set of labels to be set ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Description: set of labels to be added ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListGlossaries (removed)
Description :  Get all glossaries registered with Atlas.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary
{
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
ignoreTermsAndCategories:
{
Description: Whether ignore terms and categories ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateGlossary (removed)
Description :  Create a glossary.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary
{
atlasGlossary:
{
Description: Glossary definition, terms & categories can be anchored to a glossary. Using the anchor attribute when creating the Term/Category. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary object. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateGlossaryCategories (removed)
Description :  Create glossary category in bulk.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/categories
{
glossaryCategory:
{
Description: An array of glossary category definitions to be created. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: An array of glossary category created successfully in bulk. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateGlossaryCategory (removed)
Description :  Create a glossary category.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/category
{
glossaryCategory:
{
Description: The glossary category definition. A category must be anchored to a Glossary when creating. Optionally, terms belonging to the category and the hierarchy can also be defined during creation. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary category. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetGlossaryCategory (removed)
Description :  Get specific glossary category by its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/category/{categoryGuid}
{
categoryGuid:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary category. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_UpdateGlossaryCategory (removed)
Description :  Update the given glossary category by its GUID.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/category/{categoryGuid}
{
categoryGuid:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
glossaryCategory:
{
Description: The glossary category to be updated. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary category. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_DeleteGlossaryCategory (removed)
Description :  Delete a glossary category.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/category/{categoryGuid}
{
categoryGuid:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_PartialUpdateGlossaryCategory (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:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
partialUpdates:
{
Description: A map containing keys as attribute names and values as corresponding attribute values for partial update. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary category. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An array of related categories. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListCategoryTerms (removed)
Description :  Get all terms associated with the specific category.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/category/{categoryGuid}/terms
{
categoryGuid:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
source:
{
Description: The source of the term. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: No description available. ,
ACTIVE: No description available. ,
DEPRECATED: No description available. ,
OBSOLETE: No description available. ,
OTHER: No description available. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateGlossaryTerm (removed)
Description :  Create a glossary term.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/term
{
glossaryTerm:
{
Description: The glossary term definition. A term must be anchored to a Glossary at the time of creation. Optionally it can be categorized as well. ,
Required: True ,
}
object ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary term. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetGlossaryTerm (removed)
Description :  Get a specific glossary term by its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/term/{termGuid}
{
termGuid:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
excludeRelationshipTypes:
{
Description: An array of relationship types which need to be excluded. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary term. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_UpdateGlossaryTerm (removed)
Description :  Update the given glossary term by its GUID.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/term/{termGuid}
{
termGuid:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
glossaryTerm:
{
Description: The glossary term to be updated. ,
Required: True ,
}
object ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary term. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_DeleteGlossaryTerm (removed)
Description :  Delete a glossary term.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/term/{termGuid}
{
termGuid:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_PartialUpdateGlossaryTerm (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
{
termGuid:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
partialUpdates:
{
Description: A map containing keys as attribute names and values as corresponding attribute values to be updated. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary term. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateGlossaryTerms (removed)
Description :  Create glossary terms in bulk.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/terms
{
glossaryTerm:
{
Description: An array of glossary term definitions to be created in bulk. ,
Required: True ,
}
object ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: If bulk glossary terms creation was successful. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetEntitiesAssignedWithTerm (removed)
Description :  Get all related objects assigned with the specified term.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/terms/{termGuid}/assignedEntities
{
termGuid:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An array of related objects (if any) for the given glossary or an empty list. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_AssignTermToEntities (removed)
Description :  Assign the given term to the provided list of related objects.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/terms/{termGuid}/assignedEntities
{
termGuid:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
relatedObjectIds:
{
Description: An array of related object IDs to which the term has to be associated. ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_RemoveTermAssignmentFromEntities (removed)
Description :  Delete the term assignment for the given list of related objects.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/terms/{termGuid}/assignedEntities
{
termGuid:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
relatedObjectIds:
{
Description: An array of related object IDs from which the term has to be dissociated. ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
relatedObjectIds:
{
Description: An array of related object IDs from which the term has to be dissociated. ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
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
{
termGuid:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: An array of related glossary terms for the given glossary or an empty list. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetGlossary (removed)
Description :  Get a specific Glossary by its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary object. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_UpdateGlossary (removed)
Description :  Update the given glossary.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/{glossaryGuid}
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
ignoreTermsAndCategories:
{
Description: Whether ignore terms and categories ,
Required: False ,
}
boolean ,
updatedGlossary:
{
Description: The glossary definition to be updated. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary object. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_DeleteGlossary (removed)
Description :  Delete a glossary.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/{glossaryGuid}
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListGlossaryCategories (removed)
Description :  Get the categories belonging to a specific glossary.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/categories
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An array of glossary categories for the given glossary or an empty list. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListGlossaryCategoriesHeaders (removed)
Description :  Get the category headers belonging to a specific glossary.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/categories/headers
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetDetailedGlossary (removed)
Description :  Get a specific glossary with detailed information.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/detailed
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: The extended information of glossary. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_PartialUpdateGlossary (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.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/{glossaryGuid}/partial
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
ignoreTermsAndCategories:
{
Description: Whether ignore terms and categories ,
Required: False ,
}
boolean ,
partialUpdates:
{
Description: A map containing keys as attribute names and values as corresponding attribute values. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: The glossary object. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListGlossaryTerms (removed)
Description :  Get terms belonging to a specific glossary.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/terms
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An array of glossary terms for the given glossary or an empty list. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListGlossaryTermHeaders (removed)
Description :  Get term headers belonging to a specific glossary.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryGuid}/terms/headers
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
source:
{
Description: The source of the term. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: No description available. ,
ACTIVE: No description available. ,
DEPRECATED: No description available. ,
OBSOLETE: No description available. ,
OTHER: No description available. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ImportGlossaryTermsViaCsv (removed)
Description :  Import Glossary Terms from local csv file
Reference :  Link ¶

⚼ Request

POST:  /glossary/{glossaryGuid}/terms/import
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
includeMultiTemplates:
{
Description: Whether include multi term templates for term import/export ,
Required: False ,
}
boolean ,
file:
{
Description: The csv file to import glossary terms from. ,
Required: True ,
}
file ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: Response header for long running operation ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ImportGlossaryTermsViaCsvByGlossaryName (removed)
Description :  Import Glossary Terms from local csv file by glossaryName
Reference :  Link ¶

⚼ Request

POST:  /glossary/name/{glossaryName}/terms/import
{
glossaryName:
{
Description: The name of the glossary. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
includeMultiTemplates:
{
Description: Whether include multi term templates for term import/export ,
Required: False ,
}
boolean ,
file:
{
Description: The csv file to import glossary terms from. ,
Required: True ,
}
file ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: Response header for long running operation ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetImportCsvOperationStatus (removed)
Description :  Get the status of import csv operation
Reference :  Link ¶

⚼ Request

GET:  /glossary/terms/import/{operationGuid}
{
operationGuid:
{
Description: The globally unique identifier for async operation job. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Required: True ,
}
string ,
status:
{
Description: Enum of the status of import csv operation. ,
Enum:
{
NotStarted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Running: No description available. ,
}
,
Required: True ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: The last updated time of the record. ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
importedTerms:
{
Description: Term numbers that already imported successfully ,
Required: False ,
}
string ,
totalTermsDetected:
{
Description: Total term numbers that detected in csv ,
Required: False ,
}
string ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: Code from async job if fail ,
Required: False ,
}
string ,
message:
{
Description: Message from async job if fail ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ExportGlossaryTermsAsCsv (removed)
Description :  Export Glossary Terms as csv file
Reference :  Link ¶

⚼ Request

POST:  /glossary/{glossaryGuid}/terms/export
{
glossaryGuid:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
includeMultiTemplates:
{
Description: Whether include multi term templates for term import/export ,
Required: False ,
}
boolean ,
includeRichTextFlag:
{
Description: Whether include rich text for term export ,
Required: False ,
}
boolean ,
termGuids:
{
Description: An array of term guids. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListTermsByGlossaryName (removed)
Description :  Get terms by glossary name.
Reference :  Link ¶

⚼ Request

GET:  /glossary/name/{glossaryName}/terms
{
glossaryName:
{
Description: The name of the glossary. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
extInfo:
{
Description: Whether include extended information like contact display name and attribute values ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: An array of glossary terms for the given glossary or an empty list. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetBulkDeleteOperationStatus (removed)
Description :  Get the status of bulk delete operation
Reference :  Link ¶

⚼ Request

GET:  /glossary/terms/bulkDeletion/{operationGuid}
{
operationGuid:
{
Description: The globally unique identifier for async operation job. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Required: True ,
}
string ,
status:
{
Description: Enum of the status of bulk delete operation. ,
Enum:
{
NotStarted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Running: No description available. ,
}
,
Required: True ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: The last updated time of the record. ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
deletedTerms:
{
Description: Term numbers that already deleted successfully ,
Required: False ,
}
string ,
totalTermsDetected:
{
Description: Total term numbers that detected in a bulk delete job ,
Required: False ,
}
string ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: Code from async job if fail ,
Required: False ,
}
string ,
message:
{
Description: Message from async job if fail ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_BulkDeleteTermsByGuids (removed)
Description :  Delete Glossary Terms
Reference :  Link ¶

⚼ Request

POST:  /glossary/terms:delete
{
forceDeleteEntityAssignment:
{
Description: Whether delete entity assignment ,
Required: False ,
}
boolean ,
forceDeleteChild:
{
Description: Whether delete child terms together with the parent term ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
termGuids:
{
Description: An array of term guids to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: Response header for long running operation ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_Query (removed)
Description :  Gets data using search.
Reference :  Link ¶

⚼ Request

POST:  /search/query
{
searchRequest:
{
Description: An object specifying the search criteria. ,
Required: True ,
}
{
keywords:
{
Description: The keywords applied to all searchable fields. ,
Required: False ,
}
string ,
offset:
{
Description: The offset. The default value is 0. The maximum value is 100000. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The limit of the number of the search result. default value is 50; maximum value is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: The sort order of search results, can specify multiple fields. ,
Required: False ,
}
[
object ,
]
,
filter:
{
Description: The filter for the search. See examples for the usage of supported filters. ,
Required: False ,
}
object ,
facets:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
facet:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
sort:
{
Required: False ,
}
object ,
}
,
]
,
taxonomySetting:
{
Required: False ,
}
{
assetTypes:
{
Required: False ,
}
[
string ,
]
,
facet:
{
Description: The content of a search facet result item. ,
Required: False ,
}
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
facet:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
sort:
{
Required: False ,
}
object ,
}
,
}
,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
@search.count:
{
Description: The total number of search results (not the number of documents in a single page). ,
Format: int32 ,
Required: False ,
}
integer ,
@search.facets:
{
Description: A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets. ,
Required: False ,
}
{
entityType:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
classification:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
term:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
contactId:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
contactType:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
label:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
glossaryType:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
termStatus:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
termTemplate:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
}
,
value:
{
Required: False ,
}
[
{
@search.score:
{
Description: The search score calculated by the search engine. The results are ordered by search score by default. ,
Format: float ,
Required: False ,
}
number ,
@search.highlights:
{
Description: A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights. ,
Required: False ,
}
{
id:
{
Required: False ,
}
[
string ,
]
,
qualifiedName:
{
Required: False ,
}
[
string ,
]
,
name:
{
Required: False ,
}
[
string ,
]
,
description:
{
Required: False ,
}
[
string ,
]
,
entityType:
{
Required: False ,
}
[
string ,
]
,
}
,
objectType:
{
Description: The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term. ,
Required: False ,
}
string ,
createTime:
{
Description: The create time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
updateTime:
{
Description: The last update time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the record. ,
Required: False ,
}
string ,
entityType:
{
Description: The type name of the asset. ,
Required: False ,
}
string ,
description:
{
Description: The description of the asset. ,
Required: False ,
}
string ,
endorsement:
{
Description: The endorsement of the asset. ,
Required: False ,
}
[
string ,
]
,
owner:
{
Description: The owner of the record. This is an Atlas native attribute. ,
Required: False ,
}
string ,
classification:
{
Description: The classifications of the record. ,
Required: False ,
}
[
string ,
]
,
label:
{
Description: The labels of the asset. ,
Required: False ,
}
[
string ,
]
,
term:
{
Description: The terms assigned to the asset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the term. ,
Required: False ,
}
string ,
glossaryName:
{
Description: The name of the glossary which contains the term. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
contact:
{
Description: The contacts of the asset. ,
Required: False ,
}
[
{
id:
{
Description: The GUID of the contact. ,
Required: False ,
}
string ,
info:
{
Description: The description of the contact. ,
Required: False ,
}
string ,
contactType:
{
Description: The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Description: The asset types of the asset. ,
Required: False ,
}
[
string ,
]
,
glossaryType:
{
Description: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. ,
Required: False ,
}
string ,
glossary:
{
Description: The glossary name of the term. ,
Required: False ,
}
string ,
termStatus:
{
Description: The status of the term. ,
Required: False ,
}
string ,
termTemplate:
{
Description: The term template names used by the term. ,
Required: False ,
}
[
string ,
]
,
longDescription:
{
Description: The definition of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_Suggest (removed)
Description :  Get search suggestions by query criteria.
Reference :  Link ¶

⚼ Request

POST:  /search/suggest
{
suggestRequest:
{
Description: An object specifying the suggest criteria. ,
Required: True ,
}
{
keywords:
{
Description: The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode. ,
Required: False ,
}
string ,
limit:
{
Description: The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter for the search. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
@search.score:
{
Description: The search score calculated by the search engine. The results are ordered by search score by default. ,
Format: float ,
Required: False ,
}
number ,
@search.text:
{
Description: The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark. ,
Required: False ,
}
string ,
objectType:
{
Description: The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term. ,
Required: False ,
}
string ,
createTime:
{
Description: The create time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
updateTime:
{
Description: The last update time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the record. ,
Required: False ,
}
string ,
entityType:
{
Description: The type name of the asset. ,
Required: False ,
}
string ,
description:
{
Description: The description of the asset. ,
Required: False ,
}
string ,
endorsement:
{
Description: The endorsement of the asset. ,
Required: False ,
}
[
string ,
]
,
owner:
{
Description: The owner of the record. This is an Atlas native attribute. ,
Required: False ,
}
string ,
classification:
{
Description: The classifications of the record. ,
Required: False ,
}
[
string ,
]
,
label:
{
Description: The labels of the asset. ,
Required: False ,
}
[
string ,
]
,
term:
{
Description: The terms assigned to the asset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the term. ,
Required: False ,
}
string ,
glossaryName:
{
Description: The name of the glossary which contains the term. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
contact:
{
Description: The contacts of the asset. ,
Required: False ,
}
[
{
id:
{
Description: The GUID of the contact. ,
Required: False ,
}
string ,
info:
{
Description: The description of the contact. ,
Required: False ,
}
string ,
contactType:
{
Description: The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Description: The asset types of the asset. ,
Required: False ,
}
[
string ,
]
,
glossaryType:
{
Description: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. ,
Required: False ,
}
string ,
glossary:
{
Description: The glossary name of the term. ,
Required: False ,
}
string ,
termStatus:
{
Description: The status of the term. ,
Required: False ,
}
string ,
termTemplate:
{
Description: The term template names used by the term. ,
Required: False ,
}
[
string ,
]
,
longDescription:
{
Description: The definition of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_Browse (removed)
Description :  Browse entities by path or entity type.
Reference :  Link ¶

⚼ Request

POST:  /browse
{
browseRequest:
{
Description: An object specifying the browse criteria. ,
Required: True ,
}
{
entityType:
{
Description: The entity type to browse as the root level entry point. ,
Required: False ,
}
string ,
path:
{
Description: The path to browse the next level child entities. ,
Required: False ,
}
string ,
limit:
{
Description: The number of browse items we hope to return. The maximum value is 10000. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset. The default value is 0. The maximum value is 100000. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
@search.count:
{
Description: The total number of browse results. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Required: False ,
}
[
{
entityType:
{
Description: The type name of the record. ,
Required: False ,
}
string ,
id:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isLeaf:
{
Description: If the record is a leaf entity. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the record. ,
Required: False ,
}
string ,
owner:
{
Description: The owners of the record. ,
Required: False ,
}
[
{
id:
{
Description: The GUID of the owner. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the owner. ,
Required: False ,
}
string ,
mail:
{
Description: The mail of the owner. ,
Required: False ,
}
string ,
contactType:
{
Description: The contact type of the owner. The value will be Owner. ,
Required: False ,
}
string ,
}
,
]
,
path:
{
Description: The path of the record. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the record. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_AutoComplete (removed)
Description :  Get auto complete options.
Reference :  Link ¶

⚼ Request

POST:  /search/autocomplete
{
autoCompleteRequest:
{
Description: An object specifying the autocomplete criteria. ,
Required: True ,
}
{
keywords:
{
Description: The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters. ,
Required: False ,
}
string ,
limit:
{
Description: The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter for the autocomplete request. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
text:
{
Description: The completed term or phrase. ,
Required: False ,
}
string ,
queryPlusText:
{
Description: The completed search query text. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Lineage_GetLineageGraph (removed)
Description :  Get lineage info of the entity specified by GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/lineage/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
depth:
{
Description: The number of hops for lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
width:
{
Description: The number of max expanding width in lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
direction:
{
Description: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. ,
Required: True ,
}
string ,
includeParent:
{
Description: True to include the parent chain in the response. ,
Required: False ,
}
boolean ,
getDerivedLineage:
{
Description: True to include derived lineage in the response ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
baseEntityGuid:
{
Description: The GUID of the base entity. ,
Required: False ,
}
string ,
guidEntityMap:
{
Description: The GUID entity map. ,
Required: False ,
}
object ,
widthCounts:
{
Description: The entity count in specific direction. ,
Required: False ,
}
object ,
lineageDepth:
{
Description: The depth of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageWidth:
{
Description: The width of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
includeParent:
{
Description: True to return the parent of the base entity. ,
Required: False ,
}
boolean ,
childrenCount:
{
Description: The number of children node. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageDirection:
{
Description: The enum of lineage direction. ,
Enum:
{
INPUT: No description available. ,
OUTPUT: No description available. ,
BOTH: No description available. ,
}
,
Required: False ,
}
enum ,
parentRelations:
{
Description: An array of parentRelations relations. ,
Required: False ,
}
[
{
childEntityId:
{
Description: The GUID of child entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
parentEntityId:
{
Description: The GUID of parent entity. ,
Required: False ,
}
string ,
}
,
]
,
relations:
{
Description: An array of lineage relations. ,
Required: False ,
}
[
{
fromEntityId:
{
Description: The GUID of from-entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
toEntityId:
{
Description: The GUID of to-entity. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Lineage_NextPageLineage (removed)
Description :  Return immediate next page lineage info about entity with pagination
Reference :  Link ¶

⚼ Request

GET:  /lineage/{guid}/next/
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
direction:
{
Description: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. ,
Required: True ,
}
string ,
getDerivedLineage:
{
Description: True to include derived lineage in the response ,
Required: False ,
}
boolean ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
baseEntityGuid:
{
Description: The GUID of the base entity. ,
Required: False ,
}
string ,
guidEntityMap:
{
Description: The GUID entity map. ,
Required: False ,
}
object ,
widthCounts:
{
Description: The entity count in specific direction. ,
Required: False ,
}
object ,
lineageDepth:
{
Description: The depth of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageWidth:
{
Description: The width of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
includeParent:
{
Description: True to return the parent of the base entity. ,
Required: False ,
}
boolean ,
childrenCount:
{
Description: The number of children node. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageDirection:
{
Description: The enum of lineage direction. ,
Enum:
{
INPUT: No description available. ,
OUTPUT: No description available. ,
BOTH: No description available. ,
}
,
Required: False ,
}
enum ,
parentRelations:
{
Description: An array of parentRelations relations. ,
Required: False ,
}
[
{
childEntityId:
{
Description: The GUID of child entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
parentEntityId:
{
Description: The GUID of parent entity. ,
Required: False ,
}
string ,
}
,
]
,
relations:
{
Description: An array of lineage relations. ,
Required: False ,
}
[
{
fromEntityId:
{
Description: The GUID of from-entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
toEntityId:
{
Description: The GUID of to-entity. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Lineage_GetLineageByUniqueAttribute (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:
{
Description: The name of the type. ,
Required: True ,
}
string ,
depth:
{
Description: The number of hops for lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
width:
{
Description: The number of max expanding width in lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
direction:
{
Description: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. ,
Required: True ,
}
string ,
includeParent:
{
Description: True to include the parent chain in the response. ,
Required: False ,
}
boolean ,
getDerivedLineage:
{
Description: True to include derived lineage in the response ,
Required: False ,
}
boolean ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
baseEntityGuid:
{
Description: The GUID of the base entity. ,
Required: False ,
}
string ,
guidEntityMap:
{
Description: The GUID entity map. ,
Required: False ,
}
object ,
widthCounts:
{
Description: The entity count in specific direction. ,
Required: False ,
}
object ,
lineageDepth:
{
Description: The depth of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageWidth:
{
Description: The width of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
includeParent:
{
Description: True to return the parent of the base entity. ,
Required: False ,
}
boolean ,
childrenCount:
{
Description: The number of children node. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageDirection:
{
Description: The enum of lineage direction. ,
Enum:
{
INPUT: No description available. ,
OUTPUT: No description available. ,
BOTH: No description available. ,
}
,
Required: False ,
}
enum ,
parentRelations:
{
Description: An array of parentRelations relations. ,
Required: False ,
}
[
{
childEntityId:
{
Description: The GUID of child entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
parentEntityId:
{
Description: The GUID of parent entity. ,
Required: False ,
}
string ,
}
,
]
,
relations:
{
Description: An array of lineage relations. ,
Required: False ,
}
[
{
fromEntityId:
{
Description: The GUID of from-entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
toEntityId:
{
Description: The GUID of to-entity. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Relationship_Create (removed)
Description :  Create a new relationship between entities.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/relationship
{
relationship:
{
Description: The AtlasRelationship object containing the information for the relationship to be created. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: Atlas relationship instance. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Relationship_Update (removed)
Description :  Update an existing relationship between entities.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/relationship
{
relationship:
{
Description: The AtlasRelationship object containing the information for the relationship to be created. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: Atlas relationship instance. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Relationship_Get (removed)
Description :  Get relationship information between entities by its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/relationship/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the relationship. ,
Required: True ,
}
string ,
extendedInfo:
{
Description: Limits whether includes extended information. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
referredEntities:
{
Description: The referred entity header. ,
Required: False ,
}
object ,
relationship:
{
Description: Atlas relationship instance. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Relationship_Delete (removed)
Description :  Delete a relationship between entities by its GUID.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/relationship/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the relationship. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetBusinessMetadataDefByGuid (removed)
Description :  Get the businessMetadata definition for the given guid
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/businessmetadatadef/guid/{guid}
{
guid:
{
Description: businessMetadata guid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: On successful lookup of the the businessMetadata definition by it's guid ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetBusinessMetadataDefByName (removed)
Description :  Get the businessMetadata definition by it's name (unique)
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/businessmetadatadef/name/{name}
{
name:
{
Description: businessMetadata name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: On successful lookup of the the businessMetadata definition by it's name ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetClassificationDefByGuid (removed)
Description :  Get the classification definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/classificationdef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the classification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: class that captures details of a classification-type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetClassificationDefByName (removed)
Description :  Get the classification definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/classificationdef/name/{name}
{
name:
{
Description: The name of the classification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: class that captures details of a classification-type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetEntityDefinitionByGuid (removed)
Description :  Get the Entity definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/entitydef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: class that captures details of a entity-type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetEntityDefinitionByName (removed)
Description :  Get the entity definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/entitydef/name/{name}
{
name:
{
Description: The name of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: class that captures details of a entity-type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetEnumDefByGuid (removed)
Description :  Get the enum definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/enumdef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the enum. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: class that captures details of an enum-type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetEnumDefByName (removed)
Description :  Get the enum definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/enumdef/name/{name}
{
name:
{
Description: The name of the enum. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: class that captures details of an enum-type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetRelationshipDefByGuid (removed)
Description :  Get the relationship definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/relationshipdef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the relationship. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: AtlasRelationshipDef is a TypeDef that defines a relationship.

As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid. The name and the guid are the 2 ways that the RelationshipDef is identified.

RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally whether the end is a container.

RelationshipDefs can have AttributeDefs - though only primitive types are allowed.
RelationshipDefs have a relationshipCategory specifying the UML type of relationship required
The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs will not specify an EntityDef type name as their types.

RelationshipDefs introduce new attributes to the entity instances. For example

EntityDef A might have attributes attr1,attr2,attr3
EntityDef B might have attributes attr4,attr5,attr6
RelationshipDef AtoB might define 2 ends 

   end1:  type A, name attr7
   end2:  type B, name attr8

When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8

In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into the entity instances ,

}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetRelationshipDefByName (removed)
Description :  Get the relationship definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/relationshipdef/name/{name}
{
name:
{
Description: The name of the relationship. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: AtlasRelationshipDef is a TypeDef that defines a relationship.

As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid. The name and the guid are the 2 ways that the RelationshipDef is identified.

RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally whether the end is a container.

RelationshipDefs can have AttributeDefs - though only primitive types are allowed.
RelationshipDefs have a relationshipCategory specifying the UML type of relationship required
The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs will not specify an EntityDef type name as their types.

RelationshipDefs introduce new attributes to the entity instances. For example

EntityDef A might have attributes attr1,attr2,attr3
EntityDef B might have attributes attr4,attr5,attr6
RelationshipDef AtoB might define 2 ends 

   end1:  type A, name attr7
   end2:  type B, name attr8

When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8

In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into the entity instances ,

}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetStructDefByGuid (removed)
Description :  Get the struct definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/structdef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the struct. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: class that captures details of a struct-type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetStructDefByName (removed)
Description :  Get the struct definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/structdef/name/{name}
{
name:
{
Description: The name of the struct. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: class that captures details of a struct-type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetTypeDefinitionByGuid (removed)
Description :  Get the type definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/typedef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The definitions of type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetTypeDefinitionByName (removed)
Description :  Get the type definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/typedef/name/{name}
{
name:
{
Description: The name of the type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The definitions of type. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_DeleteTypeByName (removed)
Description :  Delete API for type identified by its name.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/types/typedef/name/{name}
{
name:
{
Description: The name of the type. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetAllTypeDefinitions (removed)
Description :  Get all type definitions in Atlas in bulk.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/typedefs
{
includeTermTemplate:
{
Description: Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template ,
Required: False ,
}
boolean ,
type:
{
Description: Typedef name as search filter when get typedefs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
object ,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
object ,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
object ,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
object ,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
object ,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
object ,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_CreateTypeDefinitions (removed)
Description :  Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/types/typedefs
{
typesDef:
{
Description: A composite wrapper object with corresponding lists of the type definition. ,
Required: True ,
}
{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
object ,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
object ,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
object ,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
object ,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
object ,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
object ,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (200)

{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
object ,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
object ,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
object ,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
object ,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
object ,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
object ,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_UpdateAtlasTypeDefinitions (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:
{
Description: A composite object that captures all type definition changes. ,
Required: True ,
}
{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
object ,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
object ,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
object ,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
object ,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
object ,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
object ,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (200)

{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
object ,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
object ,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
object ,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
object ,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
object ,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
object ,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_DeleteTypeDefinitions (removed)
Description :  Delete API for all types in bulk.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/types/typedefs
{
typesDef:
{
Description: A composite object that captures all types to be deleted ,
Required: True ,
}
{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
object ,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
object ,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
object ,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
object ,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
object ,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
object ,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_ListTypeDefinitionHeaders (removed)
Description :  List all type definitions returned as a list of minimal information header.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/typedefs/headers
{
includeTermTemplate:
{
Description: Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template ,
Required: False ,
}
boolean ,
type:
{
Description: Typedef name as search filter when get typedefs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: No description available. ,
OBJECT_ID_TYPE: No description available. ,
ENUM: No description available. ,
STRUCT: No description available. ,
CLASSIFICATION: No description available. ,
ENTITY: No description available. ,
ARRAY: No description available. ,
MAP: No description available. ,
RELATIONSHIP: No description available. ,
TERM_TEMPLATE: No description available. ,
}
,
Required: False ,
}
enum ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetTermTemplateDefByGuid (removed)
Description :  Get the term template definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /types/termtemplatedef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the term template. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: term template definition for glossary term. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Types_GetTermTemplateDefByName (removed)
Description :  Get the term template definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /types/termtemplatedef/name/{name}
{
name:
{
Description: The name of the term template. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: term template definition for glossary term. ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Collection_CreateOrUpdate (removed)
Description :  Creates or updates an entity to a collection. 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>.
Reference :  Link ¶

⚼ Request

POST:  /collections/{collection}/entity
{
collection:
{
Description: the collection unique name ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
entity:
{
Description: Atlas entity with extended information. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Collection_CreateOrUpdateBulk (removed)
Description :  Creates or updates entities in bulk to a collection. 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>.
Reference :  Link ¶

⚼ Request

POST:  /collections/{collection}/entity/bulk
{
collection:
{
Description: the collection unique name ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
entities:
{
Description: Atlas entities with extended information. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Collection_MoveEntitiesToCollection (removed)
Description :  Move existing entities to the target collection.
Reference :  Link ¶

⚼ Request

POST:  /collections/{collection}/entity/moveHere
{
collection:
{
Description: the collection unique name ,
Required: True ,
}
string ,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
moveEntitiesRequest:
{
Description: Entity guids to be moved to target collection. ,
Required: True ,
}
{
entityGuids:
{
Description: An array of entity guids to be moved to target collection. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}