Relationship - Create

Servicio:

Purview

Versión de la API:

2023-09-01

Cree una nueva relación entre entidades.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string

Cuerpo de la solicitud

Nombre	Tipo	Description
attributes		Atributos de la estructura.
createTime	integer	Hora de creación del registro.
createdBy	string	Usuario que creó el registro.
end1	AtlasObjectId	Referencia a una instancia de objeto de un tipo, como la entidad .
end2	AtlasObjectId	Referencia a una instancia de objeto de un tipo, como la entidad .
guid	string	GUID de la relación.
homeId	string	Identificador de inicio de la relación.
label	string	Etiqueta de la relación.
lastModifiedTS	string	ETag para el control de simultaneidad.
provenanceType	integer	Se usa para registrar la procedencia de una instancia de una entidad o relación
status	StatusAtlasRelationship	Enumeración del estado de la relación.
typeName	string	Nombre del tipo.
updateTime	integer	Hora de actualización del registro.
updatedBy	string	Usuario que actualizó el registro.
version	integer	Versión de la relación.

Respuestas

Nombre	Tipo	Description
200 OK	AtlasRelationship	La solicitud se ha realizado correctamente.
Other Status Codes	AtlasErrorResponse	Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Relationship_Create

Solicitud de ejemplo

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
}

Respuesta de muestra

status code:

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
}

Definiciones

Nombre	Description
AtlasErrorResponse	Una respuesta de error del servicio
AtlasObjectId	Referencia a una instancia de objeto de un tipo, como la entidad .
AtlasRelationship	Instancia de relación de Atlas.
StatusAtlasRelationship	Estado de la relación atlas

AtlasErrorResponse

Una respuesta de error del servicio

Nombre	Tipo	Description
errorCode	string	Código de error.
errorMessage	string	El mensaje de error.
requestId	string	El identificador de solicitud.

AtlasObjectId

Referencia a una instancia de objeto de un tipo, como la entidad .

Nombre	Tipo	Description
guid	string	GUID del objeto .
typeName	string	Nombre del tipo.
uniqueAttributes		Atributos únicos del objeto .

AtlasRelationship

Instancia de relación de Atlas.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
createTime	integer	Hora de creación del registro.
createdBy	string	Usuario que creó el registro.
end1	AtlasObjectId	Referencia a una instancia de objeto de un tipo, como la entidad .
end2	AtlasObjectId	Referencia a una instancia de objeto de un tipo, como la entidad .
guid	string	GUID de la relación.
homeId	string	Identificador de inicio de la relación.
label	string	Etiqueta de la relación.
lastModifiedTS	string	ETag para el control de simultaneidad.
provenanceType	integer	Se usa para registrar la procedencia de una instancia de una entidad o relación
status	StatusAtlasRelationship	Enumeración del estado de la relación.
typeName	string	Nombre del tipo.
updateTime	integer	Hora de actualización del registro.
updatedBy	string	Usuario que actualizó el registro.
version	integer	Versión de la relación.

StatusAtlasRelationship

Estado de la relación atlas

Nombre	Tipo	Description
ACTIVE	string	active
DELETED	string	deleted