Relationship - Create

Referência

Serviço:: Purview

Versão da API:: 2023-09-01

Crie uma nova relação entre entidades.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string

Corpo da solicitação

Nome	Tipo	Description
attributes		Os atributos do struct.
createTime	integer	A hora criada do registro.
createdBy	string	O usuário que criou o registro.
end1	AtlasObjectId	Referência a uma instância de objeto de um tipo , como entidade.
end2	AtlasObjectId	Referência a uma instância de objeto de um tipo , como entidade.
guid	string	O GUID da relação.
homeId	string	A ID da casa da relação.
label	string	O rótulo da relação.
lastModifiedTS	string	ETag para controle de simultaneidade.
provenanceType	integer	Usado para registrar a procedência de uma instância de uma entidade ou relação
status	StatusAtlasRelationship	A enumeração de relação status.
typeName	string	O nome do tipo.
updateTime	integer	O tempo de atualização do registro.
updatedBy	string	O usuário que atualizou o registro.
version	integer	A versão da relação.

Respostas

Nome	Tipo	Description
200 OK	AtlasRelationship	A solicitação foi bem-sucedida.
Other Status Codes	AtlasErrorResponse	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Exemplos

Relationship_Create

Solicitação de exemplo

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
}

Resposta de exemplo

Código de status:: 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
}

Definições

Nome	Description
AtlasErrorResponse	Uma resposta de erro do serviço
AtlasObjectId	Referência a uma instância de objeto de um tipo , como entidade.
AtlasRelationship	Instância de relacionamento atlas.
StatusAtlasRelationship	Status da relação atlas

AtlasErrorResponse

Uma resposta de erro do serviço

Nome	Tipo	Description
errorCode	string	O código de erro.
errorMessage	string	A mensagem de erro.
requestId	string	A ID da solicitação.

AtlasObjectId

Referência a uma instância de objeto de um tipo , como entidade.

Nome	Tipo	Description
guid	string	O GUID do objeto.
typeName	string	O nome do tipo.
uniqueAttributes		Os atributos exclusivos do objeto.

AtlasRelationship

Instância de relacionamento atlas.

Nome	Tipo	Description
attributes		Os atributos do struct.
createTime	integer	A hora criada do registro.
createdBy	string	O usuário que criou o registro.
end1	AtlasObjectId	Referência a uma instância de objeto de um tipo , como entidade.
end2	AtlasObjectId	Referência a uma instância de objeto de um tipo , como entidade.
guid	string	O GUID da relação.
homeId	string	A ID da casa da relação.
label	string	O rótulo da relação.
lastModifiedTS	string	ETag para controle de simultaneidade.
provenanceType	integer	Usado para registrar a procedência de uma instância de uma entidade ou relação
status	StatusAtlasRelationship	A enumeração de relação status.
typeName	string	O nome do tipo.
updateTime	integer	O tempo de atualização do registro.
updatedBy	string	O usuário que atualizou o registro.
version	integer	A versão da relação.

StatusAtlasRelationship

Status da relação atlas

Nome	Tipo	Description
ACTIVE	string	ativo
DELETED	string	deleted

Compartilhar via