Glossary - Assign Term To Entities

Riferimento

Servizio:: Purview

Versione API:: 2023-09-01

Assegnare il termine specificato all'elenco fornito di oggetti correlati. È consigliabile usare batch di piccole dimensioni con più chiamate API.

L'operazione Di creazione o aggiornamento delle entità è un'alternativa all'assegnazione di un termine a più entità.

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/assignedEntities

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string
termId	path	True	string	Identificatore univoco globale per il termine di glossario.

Corpo della richiesta

Nome	Tipo	Descrizione
body	AtlasRelatedObjectId[]	Matrice di ID oggetto correlati a cui deve essere associato il termine.

Risposte

Nome	Tipo	Descrizione
204 No Content		Non esiste alcun contenuto da inviare per questa richiesta, ma le intestazioni possono essere utili.
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

Glossary_AssignTermToEntities

Esempio di richiesta

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/8a7f65ec-6429-0b9b-3734-ec57bf1e34c2/assignedEntities

[
  {
    "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
    "relationshipAttributes": {
      "attributes": {
        "expression": "Example Expression",
        "confidence": 100,
        "description": "Example Description",
        "source": "ExampleSource"
      }
    }
  }
]

Risposta di esempio

Codice di stato:: 204

Definizioni

Nome	Descrizione
AtlasErrorResponse	Risposta di errore dal servizio
AtlasRelatedObjectId	Riferimento a un'istanza oggetto del tipo AtlasEntity usato nei valori degli attributi di relazione
AtlasStruct	Acquisisce i dettagli del contenuto dello struct. Non è stata creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.
EntityStatus	Stato: può essere attivo o eliminato
StatusAtlasRelationship	Stato per la relazione atlas

AtlasErrorResponse

Risposta di errore dal servizio

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

AtlasRelatedObjectId

Riferimento a un'istanza oggetto del tipo AtlasEntity usato nei valori degli attributi di relazione

Nome	Tipo	Descrizione
displayText	string	Testo visualizzato.
entityStatus	EntityStatus	Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
guid	string	GUID dell'oggetto .
relationshipAttributes	AtlasStruct	Acquisisce i dettagli del contenuto dello struct. Non è stata creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.
relationshipGuid	string	GUID della relazione.
relationshipStatus	StatusAtlasRelationship	Enumerazione dello stato della relazione.
relationshipType	string	Tipo di relazione
typeName	string	Nome del tipo.
uniqueAttributes		Attributi univoci dell'oggetto.

AtlasStruct

Acquisisce i dettagli del contenuto dello struct. Non è stata creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
lastModifiedTS	string	ETag per il controllo della concorrenza.
typeName	string	Nome del tipo.

EntityStatus

Stato: può essere attivo o eliminato

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

StatusAtlasRelationship

Stato per la relazione atlas

Nome	Tipo	Descrizione
ACTIVE	string	active
DELETED	string	deleted

Condividi tramite