EntityOperations Class
- Inheritance
-
azure.purview.catalog.operations._operations.EntityOperationsEntityOperations
Constructor
EntityOperations(*args, **kwargs)Methods
| add_classification |
Associate a classification to multiple entities in bulk. |
| add_classifications |
Add classifications to an existing entity represented by a GUID. |
| add_classifications_by_unique_attribute |
Add classification to the entity identified by its type and unique attributes. |
| add_label |
add given labels to a given entity. |
| add_labels_by_unique_attribute |
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: |
| add_or_update_business_metadata |
Add business metadata to an entity. |
| add_or_update_business_metadata_attributes |
Add or update business metadata attributes. |
| create_or_update |
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<map<string, int>>. |
| create_or_update_entities |
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<map<string, int>>. |
| delete_business_metadata |
Remove business metadata from an entity. |
| delete_business_metadata_attributes |
Delete business metadata attributes from an entity. |
| delete_by_guid |
Delete an entity identified by its GUID. |
| delete_by_guids |
Delete a list of entities in bulk identified by their GUIDs or unique attributes. |
| delete_by_unique_attribute |
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::code: |
| delete_classification |
Delete a given classification from an existing entity represented by a GUID. |
| delete_classification_by_unique_attribute |
Delete a given classification from an entity identified by its type and unique attributes. |
| delete_labels |
delete given labels to a given entity. |
| delete_labels_by_unique_attribute |
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: |
| get_by_guid |
Get complete definition of an entity given its GUID. |
| get_by_unique_attributes |
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::code: |
| get_classification |
List classifications for a given entity represented by a GUID. |
| get_classifications |
List classifications for a given entity represented by a GUID. |
| get_entities_by_unique_attributes |
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=:code: 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_0:<xref:mailto:qualifiedName=db1@cl1&attr_2>:<xref:mailto:qualifiedName=db2@cl1>. |
| get_header |
Get entity header given its GUID. |
| get_sample_business_metadata_template |
Get the sample Template for uploading/creating bulk BusinessMetaData. |
| import_business_metadata | |
| list_by_guids |
List entities in bulk identified by its GUIDs. |
| partial_update_entity_attribute_by_guid |
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. |
| partial_update_entity_by_unique_attributes |
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: |
| set_classifications |
Set classifications on entities in bulk. |
| set_labels |
Set labels to a given entity. |
| set_labels_by_unique_attribute |
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: |
| update_classifications |
Update classifications to an existing entity represented by a guid. |
| update_classifications_by_unique_attribute |
Update classification on an entity identified by its type and unique attributes. |
add_classification
Associate a classification to multiple entities in bulk.
add_classification(request: MutableMapping[str, Any], **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
request
Required
|
<xref:JSON>
The request to associate a classification to multiple entities. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
request = {
"classification": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"entityGuid": "str", # Optional. The GUID of the entity.
"entityStatus": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store. Known
values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"removePropagationsOnEntityDelete": bool, # Optional. Determines if
propagations will be removed on entity deletion.
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The end of the time
boundary.
"startTime": "str", # Optional. The start of the
time boundary.
"timeZone": "str" # Optional. The timezone of the
time boundary.
}
]
},
"entityGuids": [
"str" # Optional. The GUID of the entity.
]
}
add_classifications
Add classifications to an existing entity represented by a GUID.
add_classifications(guid: str, classifications: List[MutableMapping[str, Any]], **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
classifications
Required
|
list[<xref:JSON>]
An array of classifications to be added. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
classifications = [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"entityGuid": "str", # Optional. The GUID of the entity.
"entityStatus": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store. Known
values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"removePropagationsOnEntityDelete": bool, # Optional. Determines if
propagations will be removed on entity deletion.
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The end of the time
boundary.
"startTime": "str", # Optional. The start of the
time boundary.
"timeZone": "str" # Optional. The timezone of the
time boundary.
}
]
}
]
add_classifications_by_unique_attribute
Add classification to the entity identified by its type and unique attributes.
add_classifications_by_unique_attribute(type_name: str, atlas_classification_array: List[MutableMapping[str, Any]], *, attr_qualified_name: str | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
|
atlas_classification_array
Required
|
list[<xref:JSON>]
An array of classification to be added. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
atlas_classification_array = [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"entityGuid": "str", # Optional. The GUID of the entity.
"entityStatus": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store. Known
values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"removePropagationsOnEntityDelete": bool, # Optional. Determines if
propagations will be removed on entity deletion.
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The end of the time
boundary.
"startTime": "str", # Optional. The start of the
time boundary.
"timeZone": "str" # Optional. The timezone of the
time boundary.
}
]
}
]
add_label
add given labels to a given entity.
add_label(guid: str, body: List[str] | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
body
Required
|
set of labels to be added. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = [
"str" # Optional.
]
add_labels_by_unique_attribute
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:<attrName>=:code:<attrValue>. 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.
add_labels_by_unique_attribute(type_name: str, body: List[str] | None = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
|
body
Required
|
set of labels to be added. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = [
"str" # Optional.
]
add_or_update_business_metadata
Add business metadata to an entity.
add_or_update_business_metadata(guid: str, body: Dict[str, Any] | None = None, *, is_overwrite: bool | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
body
Required
|
Business Metadata. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
is_overwrite
|
Whether to overwrite the existing business metadata on the entity or not, default is false. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = {
"str": {} # Optional.
}
add_or_update_business_metadata_attributes
Add or update business metadata attributes.
add_or_update_business_metadata_attributes(bm_name: str, guid: str, body: Dict[str, Any] | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
bm_name
Required
|
BusinessMetadata name. |
|
guid
Required
|
The globally unique identifier of the entity. |
|
body
Required
|
BusinessMetadataAttributes. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = {
"str": {} # Optional.
}
create_or_update
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<map<string, int>>.
create_or_update(entity: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
entity
Required
|
<xref:JSON>
Atlas entity with extended information. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
entity = {
"entity": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"entityGuid": "str", # Optional. The GUID of the
entity.
"entityStatus": "str", # Optional. Status of the
entity - can be active or deleted. Deleted entities are not removed
from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the source who
create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The
end of the time boundary.
"startTime": "str", # Optional. The
start of the time boundary.
"timeZone": "str" # Optional. The
timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure Active
Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"meanings": [
{
"confidence": 0, # Optional. The confidence of the
term assignment.
"createdBy": "str", # Optional. The user who created
the record.
"description": "str", # Optional. The description of
the term assignment.
"displayText": "str", # Optional. The display text.
"expression": "str", # Optional. The expression of
the term assignment.
"relationGuid": "str", # Optional. The GUID of the
relationship.
"source": "str", # Optional. The source of the term.
"status": "str", # Optional. The status of terms
assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED",
"VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of the
term.
"termGuid": "str" # Optional. The GUID of the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the provenance of
an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of relationship.
},
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"status": "str", # Optional. Status of the entity - can be active or
deleted. Deleted entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the entity.
},
"referredEntities": {
"str": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
}
}
# response body for status code(s): 200
response.json() == {
"guidAssignments": {
"str": "str" # Optional. A map of GUID assignments with entities.
},
"mutatedEntities": {
"str": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"classificationNames": [
"str" # Optional. An array of classification
names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The
attributes of the struct.
},
"entityGuid": "str", # Optional. The
GUID of the entity.
"entityStatus": "str", # Optional.
Status of the entity - can be active or deleted. Deleted
entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional.
ETag for concurrency control.
"removePropagationsOnEntityDelete":
bool, # Optional. Determines if propagations will be removed
on entity deletion.
"source": "str", # Optional.
indicate the source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more
detail on source information.
},
"typeName": "str", # Optional. The
name of the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str",
# Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a
shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The
confidence of the term assignment.
"createdBy": "str", # Optional. The
user who created the record.
"description": "str", # Optional.
The description of the term assignment.
"displayText": "str", # Optional.
The display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional.
The GUID of the relationship.
"source": "str", # Optional. The
source of the term.
"status": "str", # Optional. The
status of terms assignment. Known values are: "DISCOVERED",
"PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED",
"OBSOLETE", "OTHER".
"steward": "str", # Optional. The
steward of the term.
"termGuid": "str" # Optional. The
GUID of the term.
}
],
"status": "str", # Optional. Status of the entity -
can be active or deleted. Deleted entities are not removed from Atlas
store. Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
},
"partialUpdatedEntities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"classificationNames": [
"str" # Optional. An array of classification names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
}
create_or_update_entities
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<map<string, int>>.
create_or_update_entities(entities: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
entities
Required
|
<xref:JSON>
An array of entities to create or update. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
entities = {
"entities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
],
"referredEntities": {
"str": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
}
}
# response body for status code(s): 200
response.json() == {
"guidAssignments": {
"str": "str" # Optional. A map of GUID assignments with entities.
},
"mutatedEntities": {
"str": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"classificationNames": [
"str" # Optional. An array of classification
names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The
attributes of the struct.
},
"entityGuid": "str", # Optional. The
GUID of the entity.
"entityStatus": "str", # Optional.
Status of the entity - can be active or deleted. Deleted
entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional.
ETag for concurrency control.
"removePropagationsOnEntityDelete":
bool, # Optional. Determines if propagations will be removed
on entity deletion.
"source": "str", # Optional.
indicate the source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more
detail on source information.
},
"typeName": "str", # Optional. The
name of the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str",
# Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a
shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The
confidence of the term assignment.
"createdBy": "str", # Optional. The
user who created the record.
"description": "str", # Optional.
The description of the term assignment.
"displayText": "str", # Optional.
The display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional.
The GUID of the relationship.
"source": "str", # Optional. The
source of the term.
"status": "str", # Optional. The
status of terms assignment. Known values are: "DISCOVERED",
"PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED",
"OBSOLETE", "OTHER".
"steward": "str", # Optional. The
steward of the term.
"termGuid": "str" # Optional. The
GUID of the term.
}
],
"status": "str", # Optional. Status of the entity -
can be active or deleted. Deleted entities are not removed from Atlas
store. Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
},
"partialUpdatedEntities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"classificationNames": [
"str" # Optional. An array of classification names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
}
delete_business_metadata
Remove business metadata from an entity.
delete_business_metadata(guid: str, body: Dict[str, Any] | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
body
Required
|
BusinessMetadata. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = {
"str": {} # Optional.
}
delete_business_metadata_attributes
Delete business metadata attributes from an entity.
delete_business_metadata_attributes(bm_name: str, guid: str, body: Dict[str, Any] | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
bm_name
Required
|
BusinessMetadata name. |
|
guid
Required
|
The globally unique identifier of the entity. |
|
body
Required
|
BusinessMetadataAttributes. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = {
"str": {} # Optional.
}
delete_by_guid
Delete an entity identified by its GUID.
delete_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"guidAssignments": {
"str": "str" # Optional. A map of GUID assignments with entities.
},
"mutatedEntities": {
"str": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"classificationNames": [
"str" # Optional. An array of classification
names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The
attributes of the struct.
},
"entityGuid": "str", # Optional. The
GUID of the entity.
"entityStatus": "str", # Optional.
Status of the entity - can be active or deleted. Deleted
entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional.
ETag for concurrency control.
"removePropagationsOnEntityDelete":
bool, # Optional. Determines if propagations will be removed
on entity deletion.
"source": "str", # Optional.
indicate the source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more
detail on source information.
},
"typeName": "str", # Optional. The
name of the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str",
# Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a
shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The
confidence of the term assignment.
"createdBy": "str", # Optional. The
user who created the record.
"description": "str", # Optional.
The description of the term assignment.
"displayText": "str", # Optional.
The display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional.
The GUID of the relationship.
"source": "str", # Optional. The
source of the term.
"status": "str", # Optional. The
status of terms assignment. Known values are: "DISCOVERED",
"PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED",
"OBSOLETE", "OTHER".
"steward": "str", # Optional. The
steward of the term.
"termGuid": "str" # Optional. The
GUID of the term.
}
],
"status": "str", # Optional. Status of the entity -
can be active or deleted. Deleted entities are not removed from Atlas
store. Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
},
"partialUpdatedEntities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"classificationNames": [
"str" # Optional. An array of classification names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
}
delete_by_guids
Delete a list of entities in bulk identified by their GUIDs or unique attributes.
delete_by_guids(*, guids: List[str], **kwargs: Any) -> MutableMapping[str, Any]Keyword-Only Parameters
| Name | Description |
|---|---|
|
guids
|
An array of GUIDs of entities to delete. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"guidAssignments": {
"str": "str" # Optional. A map of GUID assignments with entities.
},
"mutatedEntities": {
"str": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"classificationNames": [
"str" # Optional. An array of classification
names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The
attributes of the struct.
},
"entityGuid": "str", # Optional. The
GUID of the entity.
"entityStatus": "str", # Optional.
Status of the entity - can be active or deleted. Deleted
entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional.
ETag for concurrency control.
"removePropagationsOnEntityDelete":
bool, # Optional. Determines if propagations will be removed
on entity deletion.
"source": "str", # Optional.
indicate the source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more
detail on source information.
},
"typeName": "str", # Optional. The
name of the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str",
# Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a
shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The
confidence of the term assignment.
"createdBy": "str", # Optional. The
user who created the record.
"description": "str", # Optional.
The description of the term assignment.
"displayText": "str", # Optional.
The display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional.
The GUID of the relationship.
"source": "str", # Optional. The
source of the term.
"status": "str", # Optional. The
status of terms assignment. Known values are: "DISCOVERED",
"PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED",
"OBSOLETE", "OTHER".
"steward": "str", # Optional. The
steward of the term.
"termGuid": "str" # Optional. The
GUID of the term.
}
],
"status": "str", # Optional. Status of the entity -
can be active or deleted. Deleted entities are not removed from Atlas
store. Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
},
"partialUpdatedEntities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"classificationNames": [
"str" # Optional. An array of classification names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
}
delete_by_unique_attribute
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::code:=:code:.
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.
delete_by_unique_attribute(type_name: str, *, attr_qualified_name: str | None = None, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"guidAssignments": {
"str": "str" # Optional. A map of GUID assignments with entities.
},
"mutatedEntities": {
"str": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"classificationNames": [
"str" # Optional. An array of classification
names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The
attributes of the struct.
},
"entityGuid": "str", # Optional. The
GUID of the entity.
"entityStatus": "str", # Optional.
Status of the entity - can be active or deleted. Deleted
entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional.
ETag for concurrency control.
"removePropagationsOnEntityDelete":
bool, # Optional. Determines if propagations will be removed
on entity deletion.
"source": "str", # Optional.
indicate the source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more
detail on source information.
},
"typeName": "str", # Optional. The
name of the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str",
# Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a
shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The
confidence of the term assignment.
"createdBy": "str", # Optional. The
user who created the record.
"description": "str", # Optional.
The description of the term assignment.
"displayText": "str", # Optional.
The display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional.
The GUID of the relationship.
"source": "str", # Optional. The
source of the term.
"status": "str", # Optional. The
status of terms assignment. Known values are: "DISCOVERED",
"PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED",
"OBSOLETE", "OTHER".
"steward": "str", # Optional. The
steward of the term.
"termGuid": "str" # Optional. The
GUID of the term.
}
],
"status": "str", # Optional. Status of the entity -
can be active or deleted. Deleted entities are not removed from Atlas
store. Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
},
"partialUpdatedEntities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"classificationNames": [
"str" # Optional. An array of classification names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
}
delete_classification
Delete a given classification from an existing entity represented by a GUID.
delete_classification(guid: str, classification_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
classification_name
Required
|
The name of the classification. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
delete_classification_by_unique_attribute
Delete a given classification from an entity identified by its type and unique attributes.
delete_classification_by_unique_attribute(type_name: str, classification_name: str, *, attr_qualified_name: str | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
|
classification_name
Required
|
The name of the classification. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
delete_labels
delete given labels to a given entity.
delete_labels(guid: str, body: List[str] | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
body
Required
|
set of labels to be deleted. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = [
"str" # Optional.
]
delete_labels_by_unique_attribute
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:<attrName>=:code:<attrValue>. 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.
delete_labels_by_unique_attribute(type_name: str, body: List[str] | None = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
|
body
Required
|
set of labels to be deleted. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = [
"str" # Optional.
]
get_by_guid
Get complete definition of an entity given its GUID.
get_by_guid(guid: str, *, min_ext_info: bool | None = False, ignore_relationships: bool | None = False, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
min_ext_info
|
Whether to return minimal information for referred entities. Default value is False. |
|
ignore_relationships
|
Whether to ignore relationship attributes. Default value is False. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"entity": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"entityGuid": "str", # Optional. The GUID of the
entity.
"entityStatus": "str", # Optional. Status of the
entity - can be active or deleted. Deleted entities are not removed
from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the source who
create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The
end of the time boundary.
"startTime": "str", # Optional. The
start of the time boundary.
"timeZone": "str" # Optional. The
timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure Active
Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"meanings": [
{
"confidence": 0, # Optional. The confidence of the
term assignment.
"createdBy": "str", # Optional. The user who created
the record.
"description": "str", # Optional. The description of
the term assignment.
"displayText": "str", # Optional. The display text.
"expression": "str", # Optional. The expression of
the term assignment.
"relationGuid": "str", # Optional. The GUID of the
relationship.
"source": "str", # Optional. The source of the term.
"status": "str", # Optional. The status of terms
assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED",
"VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of the
term.
"termGuid": "str" # Optional. The GUID of the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the provenance of
an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of relationship.
},
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"status": "str", # Optional. Status of the entity - can be active or
deleted. Deleted entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the entity.
},
"referredEntities": {
"str": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
}
}
get_by_unique_attributes
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::code:=:code:.
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.
get_by_unique_attributes(type_name: str, *, min_ext_info: bool | None = False, ignore_relationships: bool | None = False, attr_qualified_name: str | None = None, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
min_ext_info
|
Whether to return minimal information for referred entities. Default value is False. |
|
ignore_relationships
|
Whether to ignore relationship attributes. Default value is False. |
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"entity": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"entityGuid": "str", # Optional. The GUID of the
entity.
"entityStatus": "str", # Optional. Status of the
entity - can be active or deleted. Deleted entities are not removed
from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the source who
create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The
end of the time boundary.
"startTime": "str", # Optional. The
start of the time boundary.
"timeZone": "str" # Optional. The
timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure Active
Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"meanings": [
{
"confidence": 0, # Optional. The confidence of the
term assignment.
"createdBy": "str", # Optional. The user who created
the record.
"description": "str", # Optional. The description of
the term assignment.
"displayText": "str", # Optional. The display text.
"expression": "str", # Optional. The expression of
the term assignment.
"relationGuid": "str", # Optional. The GUID of the
relationship.
"source": "str", # Optional. The source of the term.
"status": "str", # Optional. The status of terms
assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED",
"VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of the
term.
"termGuid": "str" # Optional. The GUID of the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the provenance of
an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of relationship.
},
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"status": "str", # Optional. Status of the entity - can be active or
deleted. Deleted entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the entity.
},
"referredEntities": {
"str": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
}
}
get_classification
List classifications for a given entity represented by a GUID.
get_classification(guid: str, classification_name: str, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
classification_name
Required
|
The name of the classification. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"entityGuid": "str", # Optional. The GUID of the entity.
"entityStatus": "str", # Optional. Status of the entity - can be active or
deleted. Deleted entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"removePropagationsOnEntityDelete": bool, # Optional. Determines if
propagations will be removed on entity deletion.
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The end of the time boundary.
"startTime": "str", # Optional. The start of the time
boundary.
"timeZone": "str" # Optional. The timezone of the time
boundary.
}
]
}
get_classifications
List classifications for a given entity represented by a GUID.
get_classifications(guid: str, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"list": [
{} # Optional. An array of objects.
],
"pageSize": 0, # Optional. The size of the page.
"sortBy": "str", # Optional. The sorted by field.
"sortType": "str", # Optional. to specify whether the result should be
sorted? If yes, whether asc or desc. Known values are: "NONE", "ASC", "DESC".
"startIndex": 0.0, # Optional. The start index of the page.
"totalCount": 0.0 # Optional. The total count of items.
}
get_entities_by_unique_attributes
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=:code:&attr_1::code:=:code:&attr_2::code:=:code:&attr_3::code:=:code:
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_0:<xref:mailto:qualifiedName=db1@cl1&attr_2>:<xref:mailto:qualifiedName=db2@cl1>.
get_entities_by_unique_attributes(type_name: str, *, min_ext_info: bool | None = False, ignore_relationships: bool | None = False, attr_n_qualified_name: str | None = None, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
min_ext_info
|
Whether to return minimal information for referred entities. Default value is False. |
|
ignore_relationships
|
Whether to ignore relationship attributes. Default value is False. |
|
attr_n_qualified_name
|
Qualified name of an entity. E.g. to find 2 entities you can set attrs_0:<xref:mailto:qualifiedName=db1@cl1&attrs_2>:<xref:mailto:qualifiedName=db2@cl1>. Default value is None. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"entities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
],
"referredEntities": {
"str": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
}
}
get_header
Get entity header given its GUID.
get_header(guid: str, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"classificationNames": [
"str" # Optional. An array of classification names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"entityGuid": "str", # Optional. The GUID of the entity.
"entityStatus": "str", # Optional. Status of the entity -
can be active or deleted. Deleted entities are not removed from Atlas
store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"removePropagationsOnEntityDelete": bool, # Optional.
Determines if propagations will be removed on entity deletion.
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The end of the
time boundary.
"startTime": "str", # Optional. The start of
the time boundary.
"timeZone": "str" # Optional. The timezone
of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The confidence of the term
assignment.
"createdBy": "str", # Optional. The user who created the
record.
"description": "str", # Optional. The description of the
term assignment.
"displayText": "str", # Optional. The display text.
"expression": "str", # Optional. The expression of the term
assignment.
"relationGuid": "str", # Optional. The GUID of the
relationship.
"source": "str", # Optional. The source of the term.
"status": "str", # Optional. The status of terms assignment.
Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", "VALIDATED",
"DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of the term.
"termGuid": "str" # Optional. The GUID of the term.
}
],
"status": "str", # Optional. Status of the entity - can be active or
deleted. Deleted entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
get_sample_business_metadata_template
Get the sample Template for uploading/creating bulk BusinessMetaData.
get_sample_business_metadata_template(**kwargs: Any) -> IOReturns
| Type | Description |
|---|---|
|
IO |
Exceptions
| Type | Description |
|---|---|
import_business_metadata
import_business_metadata(*args, **kwargs) -> MutableMapping[str, Any]Exceptions
| Type | Description |
|---|---|
list_by_guids
List entities in bulk identified by its GUIDs.
list_by_guids(*, guids: List[str], min_ext_info: bool | None = False, ignore_relationships: bool | None = False, exclude_relationship_types: List[str] | None = None, **kwargs: Any) -> MutableMapping[str, Any]Keyword-Only Parameters
| Name | Description |
|---|---|
|
guids
|
An array of GUIDs of entities to list. |
|
min_ext_info
|
Whether to return minimal information for referred entities. Default value is False. |
|
ignore_relationships
|
Whether to ignore relationship attributes. Default value is False. |
|
exclude_relationship_types
|
An array of the relationship types need to be excluded from the response. Default value is None. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# response body for status code(s): 200
response.json() == {
"entities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
],
"referredEntities": {
"str": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
}
}
partial_update_entity_attribute_by_guid
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.
partial_update_entity_attribute_by_guid(guid: str, body: Any, *, name: str, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
body
Required
|
The value of the attribute. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
name
|
The name of the attribute. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
partial_update_entity_by_unique_attributes
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:<attrName>=:code:<attrValue>.
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.
partial_update_entity_by_unique_attributes(type_name: str, atlas_entity_with_ext_info: MutableMapping[str, Any], *, attr_qualified_name: str | None = None, **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
|
atlas_entity_with_ext_info
Required
|
<xref:JSON>
Atlas entity with extended information. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
atlas_entity_with_ext_info = {
"entity": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"entityGuid": "str", # Optional. The GUID of the
entity.
"entityStatus": "str", # Optional. Status of the
entity - can be active or deleted. Deleted entities are not removed
from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the source who
create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The
end of the time boundary.
"startTime": "str", # Optional. The
start of the time boundary.
"timeZone": "str" # Optional. The
timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure Active
Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"meanings": [
{
"confidence": 0, # Optional. The confidence of the
term assignment.
"createdBy": "str", # Optional. The user who created
the record.
"description": "str", # Optional. The description of
the term assignment.
"displayText": "str", # Optional. The display text.
"expression": "str", # Optional. The expression of
the term assignment.
"relationGuid": "str", # Optional. The GUID of the
relationship.
"source": "str", # Optional. The source of the term.
"status": "str", # Optional. The status of terms
assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED",
"VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of the
term.
"termGuid": "str" # Optional. The GUID of the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the provenance of
an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of relationship.
},
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"status": "str", # Optional. Status of the entity - can be active or
deleted. Deleted entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the entity.
},
"referredEntities": {
"str": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"businessAttributes": {
"str": {} # Optional. Business Attributes.
},
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"contacts": {
"str": [
{
"id": "str", # Optional. Azure
Active Directory object Id.
"info": "str" # Optional. additional
information to describe this contact.
}
]
},
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"customAttributes": {
"str": "str" # Optional. Custom Attribute.
},
"guid": "str", # Optional. The GUID of the entity.
"homeId": "str", # Optional. The home ID of the entity.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"provenanceType": 0.0, # Optional. Used to record the
provenance of an instance of an entity or relationship.
"proxy": bool, # Optional. Determines if there's a proxy.
"relationshipAttributes": {
"str": {} # Optional. The attributes of
relationship.
},
"source": "str", # Optional. indicate the source who create
the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source
information.
},
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str", # Optional. The name of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the entity.
}
}
}
# response body for status code(s): 200
response.json() == {
"guidAssignments": {
"str": "str" # Optional. A map of GUID assignments with entities.
},
"mutatedEntities": {
"str": [
{
"attributes": {
"str": {} # Optional. The attributes of the
struct.
},
"classificationNames": [
"str" # Optional. An array of classification
names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The
attributes of the struct.
},
"entityGuid": "str", # Optional. The
GUID of the entity.
"entityStatus": "str", # Optional.
Status of the entity - can be active or deleted. Deleted
entities are not removed from Atlas store. Known values are:
"ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional.
ETag for concurrency control.
"removePropagationsOnEntityDelete":
bool, # Optional. Determines if propagations will be removed
on entity deletion.
"source": "str", # Optional.
indicate the source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more
detail on source information.
},
"typeName": "str", # Optional. The
name of the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str",
# Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a
shell entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for
concurrency control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The
confidence of the term assignment.
"createdBy": "str", # Optional. The
user who created the record.
"description": "str", # Optional.
The description of the term assignment.
"displayText": "str", # Optional.
The display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional.
The GUID of the relationship.
"source": "str", # Optional. The
source of the term.
"status": "str", # Optional. The
status of terms assignment. Known values are: "DISCOVERED",
"PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED",
"OBSOLETE", "OTHER".
"steward": "str", # Optional. The
steward of the term.
"termGuid": "str" # Optional. The
GUID of the term.
}
],
"status": "str", # Optional. Status of the entity -
can be active or deleted. Deleted entities are not removed from Atlas
store. Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
},
"partialUpdatedEntities": [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"classificationNames": [
"str" # Optional. An array of classification names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
]
}
set_classifications
Set classifications on entities in bulk.
set_classifications(entity_headers: MutableMapping[str, Any], **kwargs: Any) -> List[str]Parameters
| Name | Description |
|---|---|
|
entity_headers
Required
|
<xref:JSON>
Atlas entity headers. |
Returns
| Type | Description |
|---|---|
|
list of str |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
entity_headers = {
"guidHeaderMap": {
"str": {
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"classificationNames": [
"str" # Optional. An array of classification names.
],
"classifications": [
{
"attributes": {
"str": {} # Optional. The attributes
of the struct.
},
"entityGuid": "str", # Optional. The GUID of
the entity.
"entityStatus": "str", # Optional. Status of
the entity - can be active or deleted. Deleted entities are not
removed from Atlas store. Known values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag
for concurrency control.
"removePropagationsOnEntityDelete": bool, #
Optional. Determines if propagations will be removed on entity
deletion.
"source": "str", # Optional. indicate the
source who create the classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on
source information.
},
"typeName": "str", # Optional. The name of
the type.
"validityPeriods": [
{
"endTime": "str", #
Optional. The end of the time boundary.
"startTime": "str", #
Optional. The start of the time boundary.
"timeZone": "str" #
Optional. The timezone of the time boundary.
}
]
}
],
"displayText": "str", # Optional. The display text.
"guid": "str", # Optional. The GUID of the record.
"isIncomplete": bool, # Optional. Whether it is a shell
entity.
"labels": [
"str" # Optional. labels.
],
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"meaningNames": [
"str" # Optional. An array of meanings.
],
"meanings": [
{
"confidence": 0, # Optional. The confidence
of the term assignment.
"createdBy": "str", # Optional. The user who
created the record.
"description": "str", # Optional. The
description of the term assignment.
"displayText": "str", # Optional. The
display text.
"expression": "str", # Optional. The
expression of the term assignment.
"relationGuid": "str", # Optional. The GUID
of the relationship.
"source": "str", # Optional. The source of
the term.
"status": "str", # Optional. The status of
terms assignment. Known values are: "DISCOVERED", "PROPOSED",
"IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER".
"steward": "str", # Optional. The steward of
the term.
"termGuid": "str" # Optional. The GUID of
the term.
}
],
"status": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store.
Known values are: "ACTIVE", "DELETED".
"typeName": "str" # Optional. The name of the type.
}
}
}
# response body for status code(s): 200
response.json() == [
"str" # Optional.
]
set_labels
Set labels to a given entity.
set_labels(guid: str, body: List[str] | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
body
Required
|
set of labels to be set to the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = [
"str" # Optional.
]
set_labels_by_unique_attribute
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:<attrName>=:code:<attrValue>. 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.
set_labels_by_unique_attribute(type_name: str, body: List[str] | None = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
|
body
Required
|
set of labels to be set. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
body = [
"str" # Optional.
]
update_classifications
Update classifications to an existing entity represented by a guid.
update_classifications(guid: str, classifications: List[MutableMapping[str, Any]], **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
guid
Required
|
The globally unique identifier of the entity. |
|
classifications
Required
|
list[<xref:JSON>]
An array of classifications to be updated. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
classifications = [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"entityGuid": "str", # Optional. The GUID of the entity.
"entityStatus": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store. Known
values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"removePropagationsOnEntityDelete": bool, # Optional. Determines if
propagations will be removed on entity deletion.
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The end of the time
boundary.
"startTime": "str", # Optional. The start of the
time boundary.
"timeZone": "str" # Optional. The timezone of the
time boundary.
}
]
}
]
update_classifications_by_unique_attribute
Update classification on an entity identified by its type and unique attributes.
update_classifications_by_unique_attribute(type_name: str, atlas_classification_array: List[MutableMapping[str, Any]], *, attr_qualified_name: str | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
type_name
Required
|
The name of the type. |
|
atlas_classification_array
Required
|
list[<xref:JSON>]
An array of classification to be updated. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
attr_qualified_name
|
The qualified name of the entity. Default value is None. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
atlas_classification_array = [
{
"attributes": {
"str": {} # Optional. The attributes of the struct.
},
"entityGuid": "str", # Optional. The GUID of the entity.
"entityStatus": "str", # Optional. Status of the entity - can be
active or deleted. Deleted entities are not removed from Atlas store. Known
values are: "ACTIVE", "DELETED".
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"removePropagationsOnEntityDelete": bool, # Optional. Determines if
propagations will be removed on entity deletion.
"source": "str", # Optional. indicate the source who create the
classification detail.
"sourceDetails": {
"str": {} # Optional. more detail on source information.
},
"typeName": "str", # Optional. The name of the type.
"validityPeriods": [
{
"endTime": "str", # Optional. The end of the time
boundary.
"startTime": "str", # Optional. The start of the
time boundary.
"timeZone": "str" # Optional. The timezone of the
time boundary.
}
]
}
]
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for Python