Compartilhar via

Relationship - Create

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 (uri)

Corpo da solicitação

Nome Tipo Description
attributes

Os atributos do struct.
createTime

integer (int64)

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 a entidade.
end2

AtlasObjectId

Referência a uma instância de objeto de um tipo , como a 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 (int32)

Usado para registrar a procedência de uma instância de uma entidade ou relação
status

StatusAtlasRelationship

A enumeração do status da relação.
typeName

string

O nome do tipo.
updateTime

integer (int64)

A hora de atualização do registro.
updatedBy

string

O usuário que atualizou o registro.
version

integer (int64)

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

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 a entidade.
AtlasRelationship

Instância de relacionamento do Atlas.
StatusAtlasRelationship

Status da relação atlas

AtlasErrorResponse

Objeto

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 (uuid)

A ID da solicitação.

AtlasObjectId

Objeto

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

Nome Tipo Description
guid

string

O GUID do objeto.
typeName

string

O nome do tipo.
uniqueAttributes

Os atributos exclusivos do objeto.

AtlasRelationship

Objeto

Instância de relacionamento do Atlas.

Nome Tipo Description
attributes

Os atributos do struct.
createTime

integer (int64)

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 a entidade.
end2

AtlasObjectId

Referência a uma instância de objeto de um tipo , como a 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 (int32)

Usado para registrar a procedência de uma instância de uma entidade ou relação
status

StatusAtlasRelationship

A enumeração do status da relação.
typeName

string

O nome do tipo.
updateTime

integer (int64)

A hora de atualização do registro.
updatedBy

string

O usuário que atualizou o registro.
version

integer (int64)

A versão da relação.

StatusAtlasRelationship

Enumeração

Status da relação atlas

Valor Description
ACTIVE

ativo
DELETED

deleted