Entity - Bulk Create Or Update

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

Erstellen oder Aktualisieren von Entitäten im Massenvorgang. Vorhandene Entitäten werden mithilfe ihrer eindeutigen GUID abgeglichen, wenn sie angegeben wird, oder durch ihre eindeutigen Attribute, z. B. qualifiedName. Zuordnung und Array von Sammlungen werden nicht gut unterstützt. Beispiel: Arrayarray<>, Arrayzuordnungszeichenfolge<<, int>>. Für jeden Kontakttyp beträgt die maximale Anzahl von Kontakten 20.

POST {endpoint}/datamap/api/atlas/v2/entity/bulk

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string
api-version	query		string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
businessAttributeUpdateBehavior	query		BusinessAttributeUpdateBehavior	Wird verwendet, um das Updateverhalten für Geschäftsattribute beim Aktualisieren von Entitäten zu definieren.
collectionId	query		string	Die Auflistung, in die Entitäten verschoben werden. Geben Sie nur einen Wert an, wenn Sie eine Entität in eine andere Sammlung verschieben müssen.

Anforderungstext

Name	Typ	Beschreibung
entities	AtlasEntity[]	Ein Array von Entitäten.
referredEntities	<string, AtlasEntity>	Die verwiesenen Entitäten.

Antworten

Name	Typ	Beschreibung
200 OK	EntityMutationResult	Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes	AtlasErrorResponse	Eine unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://purview.azure.net/.default

Beispiele

Entity_BulkCreateOrUpdate

Beispielanforderung

HTTP

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
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
AtlasClassification	Ein instance einer Klassifizierung. Es verfügt über keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.
AtlasEntitiesWithExtInfo	Ein instance einer Entität zusammen mit erweiterten Informationen – z. B. hive_table, hive_database.
AtlasEntity	Ein instance einer Entität – z. B. hive_table, hive_database.
AtlasEntityHeader	Ein instance einer Entität – z. B. hive_table, hive_database.
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AtlasTermAssignmentHeader	Der Header für die Ausdruckszuweisung.
AtlasTermAssignmentStatus	Status für Begriffszuweisung
BusinessAttributeUpdateBehavior	Wird verwendet, um das Updateverhalten für Geschäftsattribute beim Aktualisieren von Entitäten zu definieren.
EntityMutationResult	Das Ergebnis der Mutationsantwort der Entität.
EntityStatus	Status: kann aktiv oder gelöscht werden
TimeBoundary	Erfasst Details zur Zeitgrenze

AtlasClassification

Ein instance einer Klassifizierung. Es verfügt über keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
entityGuid	string	Die GUID der Entität.
entityStatus	EntityStatus	Status der Entität – kann aktiv oder gelöscht sein. Gelöschte Entitäten werden nicht entfernt.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
removePropagationsOnEntityDelete	boolean	Bestimmt, ob Weitergaben beim Löschen von Entitäten entfernt werden.
typeName	string	Der Name des Typs.
validityPeriods	TimeBoundary[]	Ein Array von Zeitgrenzen, die Gültigkeitsdauern angeben.

AtlasEntitiesWithExtInfo

Ein instance einer Entität zusammen mit erweiterten Informationen – z. B. hive_table, hive_database.

Name	Typ	Beschreibung
entities	AtlasEntity[]	Ein Array von Entitäten.
referredEntities	<string, AtlasEntity>	Die verwiesenen Entitäten.

AtlasEntity

Ein instance einer Entität – z. B. hive_table, hive_database.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
businessAttributes		Geschäftsattribute
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
collectionId	string	Die Auflistungs-ID der Entität.
contacts	object	Das Wörterbuch der Kontakte für Entitäten. Der Schlüssel kann Experte oder Besitzer sein.
createTime	integer	Die erstellungszeit des Datensatzes.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
customAttributes	object	Benutzerdefiniertes Attribut
guid	string	Die GUID der Entität.
homeId	string	Die Start-ID der Entität.
isIncomplete	boolean	Gibt an, ob es sich um eine Shellentität handelt
labels	string[]	Bezeichnungen
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
meanings	AtlasTermAssignmentHeader[]	Ein Array von Begriffszuweisungsheadern, die die Bedeutung der Entität angibt.
provenanceType	integer	Wird verwendet, um die Herkunft eines instance einer Entität oder Beziehung aufzuzeichnen.
proxy	boolean	Bestimmt, ob ein Proxy vorhanden ist.
relationshipAttributes		Die Attribute der Beziehung.
status	EntityStatus	Status der Entität – kann aktiv oder gelöscht sein. Gelöschte Entitäten werden nicht entfernt.
typeName	string	Der Name des Typs.
updateTime	integer	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.
version	integer	Die Version der Entität.

AtlasEntityHeader

Ein instance einer Entität – z. B. hive_table, hive_database.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
classificationNames	string[]	Ein Array von Klassifizierungsnamen.
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
displayText	string	Der Anzeigetext.
guid	string	Die GUID des Datensatzes.
isIncomplete	boolean	Gibt an, ob es sich um eine Shellentität handelt
labels	string[]	Bezeichnungen
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
meaningNames	string[]	Ein Array von Bedeutungen.
meanings	AtlasTermAssignmentHeader[]	Ein Array von Begriffszuweisungsheadern.
status	EntityStatus	Status der Entität – kann aktiv oder gelöscht sein. Gelöschte Entitäten werden nicht entfernt.
typeName	string	Der Name des Typs.

AtlasErrorResponse

Eine Fehlerantwort des Diensts

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
errorMessage	string	Die Fehlermeldung.
requestId	string	Die Anforderungs-ID.

AtlasTermAssignmentHeader

Der Header für die Ausdruckszuweisung.

Name	Typ	Beschreibung
confidence	integer	Die Konfidenz der Begriffszuweisung.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
description	string	Die Beschreibung der Begriffszuweisung.
displayText	string	Der Anzeigetext.
expression	string	Der Ausdruck des Begriffs Zuweisung.
relationGuid	string	Die GUID der Beziehung.
status	AtlasTermAssignmentStatus	Die status der Begriffszuweisung.
steward	string	Der Steward des Begriffs.
termGuid	string	Die GUID des Begriffs.

AtlasTermAssignmentStatus

Status für Begriffszuweisung

Name	Typ	Beschreibung
DEPRECATED	string	Die status ist veraltet.
DISCOVERED	string	Die status wird ermittelt.
IMPORTED	string	Die status wird importiert.
OBSOLETE	string	Die status ist veraltet.
OTHER	string	Andere status.
PROPOSED	string	Die status wird vorgeschlagen.
VALIDATED	string	Die status wird überprüft.

BusinessAttributeUpdateBehavior

Wird verwendet, um das Updateverhalten für Geschäftsattribute beim Aktualisieren von Entitäten zu definieren.

Name	Typ	Beschreibung
ignore	string	Ignorieren Sie die Nutzlast des Geschäftsattributes für die Aktualisierung.
merge	string	Führen Sie die Geschäftsattribute zusammen. Geschäftsattribute werden nicht aktualisiert, wenn sie nicht bereitgestellt werden.
replace	string	Ersetzen Sie alle Geschäftsattribute mithilfe der Nutzlast.

EntityMutationResult

Das Ergebnis der Mutationsantwort der Entität.

Name	Typ	Beschreibung
guidAssignments	object	Eine Zuordnung von GUID-Zuweisungen mit Entitäten.
mutatedEntities	object	Die Entitätsheader von mutierten Entitäten.
partialUpdatedEntities	AtlasEntityHeader[]	Ein Array von Entitätsheadern, das teilweise aktualisiert wurde.

EntityStatus

Status: kann aktiv oder gelöscht werden

Name	Typ	Beschreibung
ACTIVE	string	Die status ist aktiv.
DELETED	string	Die status wird gelöscht.

TimeBoundary

Erfasst Details zur Zeitgrenze

Name	Typ	Beschreibung
endTime	string	Das Ende der Zeitgrenze.
startTime	string	Der Beginn der Zeitgrenze.
timeZone	string	Die Zeitzone der Zeitgrenze.