Relationship - Create

Riferimento

Servizio:: Purview

Versione API:: 2023-09-01

Creare una nuova relazione tra entità.

POST {endpoint}/datamap/api/atlas/v2/relationship

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string

Corpo della richiesta

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
createTime	integer	Ora creata del record.
createdBy	string	Utente che ha creato il record.
end1	AtlasObjectId	Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.
end2	AtlasObjectId	Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.
guid	string	GUID della relazione.
homeId	string	ID home della relazione.
label	string	Etichetta della relazione.
lastModifiedTS	string	ETag per il controllo di concorrenza.
provenanceType	integer	Usato per registrare la provenienza di un'istanza di un'entità o di una relazione
status	StatusAtlasRelationship	Enumerazione dello stato della relazione.
typeName	string	Nome del tipo.
updateTime	integer	Ora di aggiornamento del record.
updatedBy	string	Utente che ha aggiornato il record.
version	integer	Versione della relazione.

Risposte

Nome	Tipo	Descrizione
200 OK	AtlasRelationship	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

Relationship_Create

Esempio di richiesta

HTTP

POST {endpoint}/datamap/api/atlas/v2/relationship

{
  "typeName": "AtlasGlossarySynonym",
  "attributes": {
    "expression": "Example Expression",
    "steward": "Example Steward",
    "description": "Example Description",
    "source": null,
    "status": null
  },
  "end1": {
    "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
    "typeName": "AtlasGlossaryTerm"
  },
  "end2": {
    "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa",
    "typeName": "AtlasGlossaryTerm"
  },
  "label": "r:AtlasGlossarySynonym",
  "status": "ACTIVE",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "version": 0
}

Risposta di esempio

Codice di stato:: 200

{
  "typeName": "AtlasGlossarySynonym",
  "attributes": {
    "expression": "Example Expression",
    "steward": "Example Steward",
    "description": "Example Description",
    "source": null,
    "status": null
  },
  "guid": "63023d5b-c499-4360-a513-16bcbf73b039",
  "end1": {
    "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
    "typeName": "AtlasGlossaryTerm"
  },
  "end2": {
    "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa",
    "typeName": "AtlasGlossaryTerm"
  },
  "label": "r:AtlasGlossarySynonym",
  "status": "ACTIVE",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553840134724,
  "updateTime": 1553840134724,
  "version": 0
}

Definizioni

Nome	Descrizione
AtlasErrorResponse	Risposta di errore dal servizio
AtlasObjectId	Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.
AtlasRelationship	Istanza di relazione Atlas.
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.

AtlasObjectId

Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.

Nome	Tipo	Descrizione
guid	string	GUID dell'oggetto .
typeName	string	Nome del tipo.
uniqueAttributes		Attributi univoci dell'oggetto.

AtlasRelationship

Istanza di relazione Atlas.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
createTime	integer	Ora creata del record.
createdBy	string	Utente che ha creato il record.
end1	AtlasObjectId	Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.
end2	AtlasObjectId	Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.
guid	string	GUID della relazione.
homeId	string	ID home della relazione.
label	string	Etichetta della relazione.
lastModifiedTS	string	ETag per il controllo di concorrenza.
provenanceType	integer	Usato per registrare la provenienza di un'istanza di un'entità o di una relazione
status	StatusAtlasRelationship	Enumerazione dello stato della relazione.
typeName	string	Nome del tipo.
updateTime	integer	Ora di aggiornamento del record.
updatedBy	string	Utente che ha aggiornato il record.
version	integer	Versione della relazione.

StatusAtlasRelationship

Stato per la relazione atlas

Nome	Tipo	Descrizione
ACTIVE	string	active
DELETED	string	deleted

Condividi tramite