Entity - Bulk Create Or Update

Dienst:: Purview

API-Version:: 2023-09-01

Erstellen oder Aktualisieren von Entitäten in Massen. Vorhandene Entität wird mit ihrer eindeutigen GUID abgeglichen, wenn sie angegeben oder durch ihre eindeutigen Attribute angegeben wird, z. B.: qualifiedName. Zuordnung und Array von Sammlungen werden nicht gut unterstützt. Z. B. Array-Array<<int>>, Array-Map-Zeichenfolge<<, 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 (uri)
api-version	query		string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
businessAttributeUpdateBehavior	query		BusinessAttributeUpdateBehavior	Wird verwendet, um das Updateverhalten für Geschäftsattribute beim Aktualisieren von Entitäten zu definieren.
collectionId	query		string	Die Sammlung, 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 ist erfolgreich.
Other Status Codes	AtlasErrorResponse	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	Eine Instanz einer Klassifizierung; es hat keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.
AtlasEntitiesWithExtInfo	Eine Instanz einer Entität zusammen mit erweiterten Informationen , z. B. hive_table, hive_database.
AtlasEntity	Eine Instanz einer Entität , z. B. hive_table, hive_database.
AtlasEntityHeader	Eine Instanz 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 Die Begriffszuweisung
BusinessAttributeUpdateBehavior	Wird verwendet, um das Updateverhalten für Geschäftsattribute beim Aktualisieren von Entitäten zu definieren.
EntityMutationResult	Das Mutationsantwortergebnis der Entität.
EntityStatus	Status – kann aktiv oder gelöscht werden
TimeBoundary	Erfasst Zeitbegrenzungsdetails

AtlasClassification

Objekt

Eine Instanz einer Klassifizierung; es hat 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 werden. Gelöschte Entitäten werden nicht entfernt.
lastModifiedTS	string	ETag für Parallelitätssteuerelement.
removePropagationsOnEntityDelete	boolean	Bestimmt, ob Verteilungen beim Löschen der Entität entfernt werden.
typeName	string	Der Name des Typs.
validityPeriods	TimeBoundary[]	Ein Array von Zeitgrenzen, das gültigkeitsperioden angibt.

AtlasEntitiesWithExtInfo

Objekt

Eine Instanz 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

Objekt

Eine Instanz 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 Sammlungs-ID der Entität.
contacts	object	Das Wörterbuch der Kontakte für Entitäten. Schlüssel kann Experte oder Besitzer sein.
createTime	integer (int64)	Die erstellte Zeit 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[]	etiketten
lastModifiedTS	string	ETag für Parallelitätssteuerelement.
meanings	AtlasTermAssignmentHeader[]	Ein Array von Begriffszuweisungsheadern, die die Bedeutungen der Entität angeben.
provenanceType	integer (int32)	Wird verwendet, um die Provenienz einer Instanz 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 werden. Gelöschte Entitäten werden nicht entfernt.
typeName	string	Der Name des Typs.
updateTime	integer (int64)	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.
version	integer (int64)	Die Version der Entität.

AtlasEntityHeader

Objekt

Eine Instanz 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[]	etiketten
lastModifiedTS	string	ETag für Parallelitätssteuerelement.
meaningNames	string[]	Ein Array von Bedeutungen.
meanings	AtlasTermAssignmentHeader[]	Ein Array von Ausdruckszuweisungsheadern.
status	EntityStatus	Status der Entität – kann aktiv oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
typeName	string	Der Name des Typs.

AtlasErrorResponse

Objekt

Eine Fehlerantwort des Diensts

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

AtlasTermAssignmentHeader

Objekt

Der Header für die Ausdruckszuweisung.

Name	Typ	Beschreibung
confidence	integer (int32)	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 der Ausdruckszuweisung.
relationGuid	string (uuid)	Die GUID der Beziehung.
status	AtlasTermAssignmentStatus	Der Status der Begriffszuweisung.
steward	string	Der Steward des Begriffs.
termGuid	string (uuid)	Die GUID des Ausdrucks.

AtlasTermAssignmentStatus

Enumeration

Status für Die Begriffszuweisung

Wert	Beschreibung
DISCOVERED	Der Status wird ermittelt.
PROPOSED	Der Status wird vorgeschlagen.
IMPORTED	Der Status wird importiert.
VALIDATED	Der Status wird überprüft.
DEPRECATED	Der Status ist veraltet.
OBSOLETE	Der Status ist veraltet.
OTHER	Anderer Status.

BusinessAttributeUpdateBehavior

Enumeration

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

Wert	Beschreibung
ignore	Ignorieren Sie die Business-Attributnutzlast für die Aktualisierung.
replace	Ersetzen Sie alle Geschäftsattribute mithilfe der Nutzlast.
merge	Führen Sie die Geschäftsattribute zusammen. Geschäftsattribute werden nicht aktualisiert, wenn sie nicht angegeben werden.

EntityMutationResult

Objekt

Das Mutationsantwortergebnis der Entität.

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

EntityStatus

Enumeration

Status – kann aktiv oder gelöscht werden

Wert	Beschreibung
ACTIVE	Der Status ist aktiv.
DELETED	Der Status wird gelöscht.

TimeBoundary

Objekt

Erfasst Zeitbegrenzungsdetails

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

Freigeben über

Entity - Bulk Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

Entity_BulkCreateOrUpdate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AtlasClassification

AtlasEntitiesWithExtInfo

AtlasEntity

AtlasEntityHeader

AtlasErrorResponse

AtlasTermAssignmentHeader

AtlasTermAssignmentStatus

BusinessAttributeUpdateBehavior

EntityMutationResult

EntityStatus

TimeBoundary