CollectionOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:collection> attribute.
- Inheritance
-
builtins.objectCollectionOperations
Constructor
CollectionOperations(*args, **kwargs)Methods
| create_or_update |
Creates or updates an entity to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array*>, array<map<string, int>>. |
| create_or_update_bulk |
Creates or updates entities in bulk to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array*>, array<map<string, int>>. |
| move_entities_to_collection |
Move existing entities to the target collection. |
create_or_update
Creates or updates an entity to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array*>, array<map<string, int>>.
create_or_update(collection: str, entity: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
collection
Required
|
the collection unique name. |
|
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_bulk
Creates or updates entities in bulk to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array*>, array<map<string, int>>.
create_or_update_bulk(collection: str, entities: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
collection
Required
|
the collection unique name. |
|
entities
Required
|
<xref:JSON>
Atlas entities 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.
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.
}
]
}
move_entities_to_collection
Move existing entities to the target collection.
move_entities_to_collection(collection: str, move_entities_request: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, Any]Parameters
| Name | Description |
|---|---|
|
collection
Required
|
the collection unique name. |
|
move_entities_request
Required
|
<xref:JSON>
Entity guids to be moved to target collection. |
Returns
| Type | Description |
|---|---|
|
<xref:JSON>
|
JSON object |
Exceptions
| Type | Description |
|---|---|
Examples
# JSON input template you can fill out and use as your body input.
move_entities_request = {
"entityGuids": [
"str" # Optional. An array of entity guids to be moved to target
collection.
]
}
# 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.
}
]
}
Collaborer avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner les problèmes et les demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.
Azure SDK for Python