Entity - Bulk Create Or Update

Riferimento

Servizio:: Purview

Versione API:: 2023-09-01

Creare o aggiornare entità in blocco. L'entità esistente viene confrontata usando il guid univoco, se specificato o dai relativi attributi univoci, ad esempio qualifiedName. La mappa e la matrice di raccolte non sono supportate correttamente. Ad esempio, matrice di matrici><, stringa della mappa di matrici<<, int>>. Per ogni tipo di contatto, il numero massimo di contatti è 20.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string
api-version	query		string	Versione dell'API da usare per questa operazione.
businessAttributeUpdateBehavior	query		BusinessAttributeUpdateBehavior	Usato per definire il comportamento di aggiornamento per gli attributi aziendali durante l'aggiornamento delle entità.
collectionId	query		string	Raccolta in cui verranno spostate le entità. Specificare un valore solo se è necessario spostare un'entità in un'altra raccolta.

Corpo della richiesta

Nome	Tipo	Descrizione
entities	AtlasEntity[]	Matrice di entità.
referredEntities	<string, AtlasEntity>	Entità di riferimento.

Risposte

Nome	Tipo	Descrizione
200 OK	EntityMutationResult	La richiesta ha avuto esito positivo.
Other Status Codes	AtlasErrorResponse	Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://purview.azure.net/.default

Esempio

Entity_BulkCreateOrUpdate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
AtlasClassification	Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo se associato a un'entità.
AtlasEntitiesWithExtInfo	Istanza di un'entità con informazioni estese, ad esempio hive_table hive_database.
AtlasEntity	Istanza di un'entità, ad esempio hive_table, hive_database.
AtlasEntityHeader	Istanza di un'entità, ad esempio hive_table, hive_database.
AtlasErrorResponse	Risposta di errore dal servizio
AtlasTermAssignmentHeader	Intestazione per l'assegnazione di termini.
AtlasTermAssignmentStatus	Stato per l'assegnazione di termini
BusinessAttributeUpdateBehavior	Usato per definire il comportamento di aggiornamento per gli attributi aziendali durante l'aggiornamento delle entità.
EntityMutationResult	Risultato della risposta alla mutazione dell'entità.
EntityStatus	Stato: può essere attivo o eliminato
TimeBoundary	Acquisisce i dettagli dei limiti di tempo

AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo se associato a un'entità.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
entityGuid	string	GUID dell'entità.
entityStatus	EntityStatus	Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
lastModifiedTS	string	ETag per il controllo della concorrenza.
removePropagationsOnEntityDelete	boolean	Determina se le propagazioni verranno rimosse durante l'eliminazione dell'entità.
typeName	string	Nome del tipo.
validityPeriods	TimeBoundary[]	Matrice di limiti di tempo che indica i periodi di validità.

AtlasEntitiesWithExtInfo

Istanza di un'entità con informazioni estese, ad esempio hive_table hive_database.

Nome	Tipo	Descrizione
entities	AtlasEntity[]	Matrice di entità.
referredEntities	<string, AtlasEntity>	Entità di riferimento.

AtlasEntity

Istanza di un'entità, ad esempio hive_table, hive_database.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
businessAttributes		Attributi business
classifications	AtlasClassification[]	Matrice di classificazioni.
collectionId	string	ID raccolta dell'entità.
contacts	object	Dizionario dei contatti per le entità. La chiave può essere Expert o Owner.
createTime	integer	Ora di creazione del record.
createdBy	string	Utente che ha creato il record.
customAttributes	object	Attributo personalizzato
guid	string	GUID dell'entità.
homeId	string	ID home dell'entità.
isIncomplete	boolean	Indica se si tratta di un'entità shell
labels	string[]	Etichette
lastModifiedTS	string	ETag per il controllo della concorrenza.
meanings	AtlasTermAssignmentHeader[]	Matrice di intestazioni di assegnazione di termini che indica i significati dell'entità.
provenanceType	integer	Usato per registrare la provenienza di un'istanza di un'entità o di una relazione.
proxy	boolean	Determina se è presente un proxy.
relationshipAttributes		Attributi della relazione.
status	EntityStatus	Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
typeName	string	Nome del tipo.
updateTime	integer	Ora di aggiornamento del record.
updatedBy	string	Utente che ha aggiornato il record.
version	integer	Versione dell'entità.

AtlasEntityHeader

Istanza di un'entità, ad esempio hive_table, hive_database.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
classificationNames	string[]	Matrice di nomi di classificazione.
classifications	AtlasClassification[]	Matrice di classificazioni.
displayText	string	Testo visualizzato.
guid	string	GUID del record.
isIncomplete	boolean	Indica se si tratta di un'entità shell
labels	string[]	Etichette
lastModifiedTS	string	ETag per il controllo della concorrenza.
meaningNames	string[]	Matrice di significati.
meanings	AtlasTermAssignmentHeader[]	Matrice di intestazioni di assegnazione di termini.
status	EntityStatus	Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
typeName	string	Nome del tipo.

AtlasErrorResponse

Risposta di errore dal servizio

Nome	Tipo	Descrizione
errorCode	string	Codice di errore.
errorMessage	string	Messaggio di errore.
requestId	string	ID richiesta.

AtlasTermAssignmentHeader

Intestazione per l'assegnazione di termini.

Nome	Tipo	Descrizione
confidence	integer	Attendibilità dell'assegnazione del termine.
createdBy	string	Utente che ha creato il record.
description	string	Descrizione dell'assegnazione del termine.
displayText	string	Testo visualizzato.
expression	string	Espressione dell'assegnazione del termine.
relationGuid	string	GUID della relazione.
status	AtlasTermAssignmentStatus	Stato dell'assegnazione dei termini.
steward	string	Amministratore del termine.
termGuid	string	GUID del termine.

AtlasTermAssignmentStatus

Stato per l'assegnazione di termini

Nome	Tipo	Descrizione
DEPRECATED	string	Lo stato è deprecato.
DISCOVERED	string	Lo stato viene individuato.
IMPORTED	string	Lo stato viene importato.
OBSOLETE	string	Lo stato è obsoleto.
OTHER	string	Altro stato.
PROPOSED	string	Lo stato viene proposto.
VALIDATED	string	Lo stato viene convalidato.

BusinessAttributeUpdateBehavior

Usato per definire il comportamento di aggiornamento per gli attributi aziendali durante l'aggiornamento delle entità.

Nome	Tipo	Descrizione
ignore	string	Ignorare il payload dell'attributo business per l'aggiornamento.
merge	string	Unire gli attributi business. Gli attributi business non verranno aggiornati se non specificati.
replace	string	Sostituire tutti gli attributi business usando il payload.

EntityMutationResult

Risultato della risposta alla mutazione dell'entità.

Nome	Tipo	Descrizione
guidAssignments	object	Mappa delle assegnazioni GUID con entità.
mutatedEntities	object	Intestazioni di entità di entità mutate.
partialUpdatedEntities	AtlasEntityHeader[]	Matrice di intestazioni di entità che sono state aggiornate parzialmente.

EntityStatus

Stato: può essere attivo o eliminato

Nome	Tipo	Descrizione
ACTIVE	string	Lo stato è attivo.
DELETED	string	Lo stato viene eliminato.

TimeBoundary

Acquisisce i dettagli dei limiti di tempo

Nome	Tipo	Descrizione
endTime	string	Fine del limite di tempo.
startTime	string	Inizio del limite di tempo.
timeZone	string	Fuso orario del limite di tempo.