Entity - Move Entities To Collection

Servizio:: Purview

Versione API:: 2023-09-01

Spostare le entità esistenti nella raccolta di destinazione.

POST {endpoint}/datamap/api/entity/moveTo?api-version=2023-09-01&collectionId={collectionId}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
collectionId	query	True	string	Raccolta in cui verranno spostate le entità.

Corpo della richiesta

Nome	Tipo	Descrizione
entityGuids	string[]	Matrice di GUID di entità da spostare nella raccolta di destinazione.

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_MoveEntitiesToCollection

Esempio di richiesta

HTTP

POST {endpoint}/datamap/api/entity/moveTo?api-version=2023-09-01&collectionId=ExampleNewCollection

{
  "entityGuids": [
    "321493e3-3fb7-4b3e-9df7-3b69154174c2",
    "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
  ]
}

Risposta di esempio

Codice di stato:: 200

{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount"
        },
        "lastModifiedTS": "3",
        "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1",
        "status": "ACTIVE"
      },
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount2"
        },
        "lastModifiedTS": "2",
        "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à.
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
EntityMutationResult	Risultato della risposta alla mutazione dell'entità.
EntityStatus	Stato: può essere attivo o eliminato
MoveEntitiesOptions	MoveEntitiesOptions
TimeBoundary	Acquisisce i dettagli del limite di tempo

AtlasClassification

Object

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 indicano i periodi di validità.

AtlasEntityHeader

Object

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

Object

Risposta di errore dal servizio

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

AtlasTermAssignmentHeader

Object

Intestazione per l'assegnazione di termini.

Nome	Tipo	Descrizione
confidence	integer (int32)	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 (uuid)	GUID della relazione.
status	AtlasTermAssignmentStatus	Stato dell'assegnazione dei termini.
steward	string	L'amministratore del termine.
termGuid	string (uuid)	GUID del termine.

AtlasTermAssignmentStatus

Enumerazione

Stato per l'assegnazione di termini

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

EntityMutationResult

Object

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

Enumerazione

Stato: può essere attivo o eliminato

Valore	Descrizione
ACTIVE	Lo stato è attivo.
DELETED	Lo stato viene eliminato.

MoveEntitiesOptions

Object

MoveEntitiesOptions

Nome	Tipo	Descrizione
entityGuids	string[]	Matrice di GUID di entità da spostare nella raccolta di destinazione.

TimeBoundary

Object

Acquisisce i dettagli del limite 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.