Partager via

Entity - Bulk Create Or Update

Service:
Purview
Version d'API:
2023-09-01

Créez ou mettez à jour des entités en bloc. L’entité existante est mise en correspondance à l’aide de son guid unique si elle est fournie ou par ses attributs uniques, par exemple : qualifiedName. Les mappages et les tableaux de collections ne sont pas bien pris en charge. Par exemple, tableau<tableau<int>>, chaîne de carte<de tableau<, int>>. Pour chaque type de contact, le nombre maximal de contacts est de 20.

POST {endpoint}/datamap/api/atlas/v2/entity/bulk
Avec des paramètres facultatifs: 
POST {endpoint}/datamap/api/atlas/v2/entity/bulk?api-version=2023-09-01&collectionId={collectionId}&businessAttributeUpdateBehavior={businessAttributeUpdateBehavior}

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string (uri)

api-version
 query

string

minLength: 1

Version de l’API à utiliser pour cette opération.
businessAttributeUpdateBehavior
 query

BusinessAttributeUpdateBehavior

Utilisé pour définir le comportement de mise à jour pour les attributs métier lors de la mise à jour d’entités.
collectionId
 query

string

Collection vers laquelle les entités seront déplacées. Spécifiez une valeur uniquement si vous devez déplacer une entité vers une autre collection.

Corps de la demande

Nom Type Description
entities

AtlasEntity[]

Tableau d’entités.
referredEntities

<string,  AtlasEntity>

Entités référencées.

Réponses

Nom Type Description
200 OK

EntityMutationResult

La demande a réussi.
Other Status Codes

AtlasErrorResponse

Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
https://purview.azure.net/.default

Exemples

Entity_BulkCreateOrUpdate

Exemple de requête

POST {endpoint}/datamap/api/atlas/v2/entity/bulk?api-version=2023-09-01

{
  "referredEntities": {},
  "entities": [
    {
      "typeName": "azure_storage_account",
      "attributes": {
        "owner": "ExampleOwner",
        "modifiedTime": 0,
        "createTime": 0,
        "qualifiedName": "exampleaccount1",
        "name": "ExampleStorageAccount1",
        "description": null,
        "publicAccessLevel": null
      },
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Owner": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Owner Info"
          }
        ]
      },
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "version": 0
    },
    {
      "typeName": "azure_storage_account",
      "attributes": {
        "owner": "ExampleOwner",
        "modifiedTime": 0,
        "createTime": 0,
        "qualifiedName": "exampleaccount2",
        "name": "ExampleStorageAccount2",
        "description": "Example Description",
        "publicAccessLevel": null
      },
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Owner": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Owner Info"
          }
        ]
      },
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "version": 0
    }
  ]
}

Exemple de réponse

Code d’état:
200 
{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount2"
        },
        "lastModifiedTS": "2",
        "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1",
        "status": "ACTIVE"
      }
    ],
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount1"
        },
        "lastModifiedTS": "1",
        "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
        "status": "ACTIVE"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
    "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
  }
}

Définitions

Nom Description
AtlasClassification

Instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.
AtlasEntitiesWithExtInfo

Instance d’une entité avec des informations étendues, comme hive_table, hive_database.
AtlasEntity

Instance d’une entité, comme hive_table, hive_database.
AtlasEntityHeader

Instance d’une entité, comme hive_table, hive_database.
AtlasErrorResponse

Réponse d’erreur du service
AtlasTermAssignmentHeader

En-tête de l’affectation de terme.
AtlasTermAssignmentStatus

État de l’affectation de terme
BusinessAttributeUpdateBehavior

Utilisé pour définir le comportement de mise à jour pour les attributs métier lors de la mise à jour d’entités.
EntityMutationResult

Résultat de la réponse de mutation de l’entité.
EntityStatus

État : peut être actif ou supprimé
TimeBoundary

Capture les détails des limites temporelles

AtlasClassification

Object

Instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.

Nom Type Description
attributes

Attributs du struct.
entityGuid

string

GUID de l’entité.
entityStatus

EntityStatus

État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
lastModifiedTS

string

ETag pour le contrôle d’accès concurrentiel.
removePropagationsOnEntityDelete

boolean

Détermine si les propagations seront supprimées lors de la suppression d’entité.
typeName

string

Nom du type.
validityPeriods

TimeBoundary[]

Tableau de limites de temps indiquant les périodes de validité.

AtlasEntitiesWithExtInfo

Object

Instance d’une entité avec des informations étendues, comme hive_table, hive_database.

Nom Type Description
entities

AtlasEntity[]

Tableau d’entités.
referredEntities

<string,  AtlasEntity>

Entités référencées.

AtlasEntity

Object

Instance d’une entité, comme hive_table, hive_database.

Nom Type Description
attributes

Attributs du struct.
businessAttributes

Attributs métier
classifications

AtlasClassification[]

Tableau de classifications.
collectionId

string

ID de collection de l’entité.
contacts

object

Dictionnaire de contacts pour les entités. La clé peut être expert ou propriétaire.
createTime

integer (int64)

Heure créée de l’enregistrement.
createdBy

string

Utilisateur qui a créé l’enregistrement.
customAttributes

object

Attribut personnalisé
guid

string

GUID de l’entité.
homeId

string

ID d’accueil de l’entité.
isIncomplete

boolean

Indique s’il s’agit d’une entité shell
labels

string[]

Étiquettes
lastModifiedTS

string

ETag pour le contrôle d’accès concurrentiel.
meanings

AtlasTermAssignmentHeader[]

Tableau d’en-têtes d’affectation de termes indiquant les significations de l’entité.
provenanceType

integer (int32)

Permet d’enregistrer la provenance d’une instance d’une entité ou d’une relation.
proxy

boolean

Détermine s’il existe un proxy.
relationshipAttributes

Attributs de relation.
status

EntityStatus

État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
typeName

string

Nom du type.
updateTime

integer (int64)

Heure de mise à jour de l’enregistrement.
updatedBy

string

Utilisateur qui a mis à jour l’enregistrement.
version

integer (int64)

Version de l’entité.

AtlasEntityHeader

Object

Instance d’une entité, comme hive_table, hive_database.

Nom Type Description
attributes

Attributs du struct.
classificationNames

string[]

Tableau de noms de classification.
classifications

AtlasClassification[]

Tableau de classifications.
displayText

string

Texte d’affichage.
guid

string

GUID de l’enregistrement.
isIncomplete

boolean

Indique s’il s’agit d’une entité shell
labels

string[]

Étiquettes
lastModifiedTS

string

ETag pour le contrôle d’accès concurrentiel.
meaningNames

string[]

Tableau de significations.
meanings

AtlasTermAssignmentHeader[]

Tableau d’en-têtes d’affectation de terme.
status

EntityStatus

État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
typeName

string

Nom du type.

AtlasErrorResponse

Object

Réponse d’erreur du service

Nom Type Description
errorCode

string

Code d’erreur.
errorMessage

string

Message d’erreur.
requestId

string (uuid)

ID de demande.

AtlasTermAssignmentHeader

Object

En-tête de l’affectation de terme.

Nom Type Description
confidence

integer (int32)

Confiance de l’affectation de terme.
createdBy

string

Utilisateur qui a créé l’enregistrement.
description

string

Description de l’affectation de terme.
displayText

string

Texte d’affichage.
expression

string

Expression de l’affectation de terme.
relationGuid

string (uuid)

GUID de la relation.
status

AtlasTermAssignmentStatus

État de l’affectation de termes.
steward

string

L’administrateur du terme.
termGuid

string (uuid)

GUID du terme.

AtlasTermAssignmentStatus

Énumération

État de l’affectation de terme

Valeur Description
DISCOVERED

L’état est découvert.
PROPOSED

Le statut est proposé.
IMPORTED

L’état est importé.
VALIDATED

L’état est validé.
DEPRECATED

L’état est déconseillé.
OBSOLETE

L’état est obsolète.
OTHER

Autre état.

BusinessAttributeUpdateBehavior

Énumération

Utilisé pour définir le comportement de mise à jour pour les attributs métier lors de la mise à jour d’entités.

Valeur Description
ignore

Ignorez la charge utile de l’attribut métier pour la mise à jour.
replace

Remplacez tous les attributs métier à l’aide de la charge utile.
merge

Fusionnez les attributs métier. Les attributs métier ne seront pas mis à jour s’ils ne sont pas fournis.

EntityMutationResult

Object

Résultat de la réponse de mutation de l’entité.

Nom Type Description
guidAssignments

object

Mappage des affectations GUID avec des entités.
mutatedEntities

object

En-têtes d’entité des entités mutées.
partialUpdatedEntities

AtlasEntityHeader[]

Tableau d’en-têtes d’entité partiellement mis à jour.

EntityStatus

Énumération

État : peut être actif ou supprimé

Valeur Description
ACTIVE

L’état est actif.
DELETED

L’état est supprimé.

TimeBoundary

Object

Capture les détails des limites temporelles

Nom Type Description
endTime

string

Fin de la limite de temps.
startTime

string

Début de la limite de temps.
timeZone

string

Fuseau horaire de la limite de temps.