Partager via

Relationship - Create

Service:
Purview
Version d'API:
2023-09-01

Créez une relation entre les entités.

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

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string (uri)

Corps de la demande

Nom Type Description
attributes

Attributs du struct.
createTime

integer (int64)

Heure créée de l’enregistrement.
createdBy

string

Utilisateur qui a créé l’enregistrement.
end1

AtlasObjectId

Référence à une instance d’objet d’un type, telle qu’une entité.
end2

AtlasObjectId

Référence à une instance d’objet d’un type, telle qu’une entité.
guid

string

GUID de la relation.
homeId

string

ID d’accueil de la relation.
label

string

Étiquette de la relation.
lastModifiedTS

string

ETag pour le contrôle d’accès concurrentiel.
provenanceType

integer (int32)

Utilisé pour enregistrer la provenance d’une instance d’une entité ou d’une relation
status

StatusAtlasRelationship

Énumération de l’état de relation.
typeName

string

Nom du type.
updateTime

integer (int64)

Heure de mise à jour de l’enregistrement.
updatedBy

string

Utilisateur qui a mis à jour l’enregistrement.
version

integer (int64)

Version de la relation.

Réponses

Nom Type Description
200 OK

AtlasRelationship

La demande a réussi.
Other Status Codes

AtlasErrorResponse

Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
https://purview.azure.net/.default

Exemples

Relationship_Create

Exemple de requête

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
}

Exemple de réponse

Code d’état:
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
}

Définitions

Nom Description
AtlasErrorResponse

Réponse d’erreur du service
AtlasObjectId

Référence à une instance d’objet d’un type, telle qu’une entité.
AtlasRelationship

Instance de relation Atlas.
StatusAtlasRelationship

État de la relation atlas

AtlasErrorResponse

Object

Réponse d’erreur du service

Nom Type Description
errorCode

string

Code d’erreur.
errorMessage

string

Message d’erreur.
requestId

string (uuid)

ID de demande.

AtlasObjectId

Object

Référence à une instance d’objet d’un type, telle qu’une entité.

Nom Type Description
guid

string

GUID de l’objet.
typeName

string

Nom du type.
uniqueAttributes

Attributs uniques de l’objet.

AtlasRelationship

Object

Instance de relation Atlas.

Nom Type Description
attributes

Attributs du struct.
createTime

integer (int64)

Heure créée de l’enregistrement.
createdBy

string

Utilisateur qui a créé l’enregistrement.
end1

AtlasObjectId

Référence à une instance d’objet d’un type, telle qu’une entité.
end2

AtlasObjectId

Référence à une instance d’objet d’un type, telle qu’une entité.
guid

string

GUID de la relation.
homeId

string

ID d’accueil de la relation.
label

string

Étiquette de la relation.
lastModifiedTS

string

ETag pour le contrôle d’accès concurrentiel.
provenanceType

integer (int32)

Utilisé pour enregistrer la provenance d’une instance d’une entité ou d’une relation
status

StatusAtlasRelationship

Énumération de l’état de relation.
typeName

string

Nom du type.
updateTime

integer (int64)

Heure de mise à jour de l’enregistrement.
updatedBy

string

Utilisateur qui a mis à jour l’enregistrement.
version

integer (int64)

Version de la relation.

StatusAtlasRelationship

Énumération

État de la relation atlas

Valeur Description
ACTIVE

active
DELETED

deleted