Twins - DigitalTwins AddRelationship

Service:

Azure Digital Twins

API Version:

2023-10-31

Adiciona uma relação entre dois gêmeos digitais. Códigos de status:

• 200 OK
• 400 Solicitação Inválida
  • InvalidArgument - A ID do gêmeo digital, a ID da relação ou o conteúdo são inválidos.
  • InvalidRelationship – a relação é inválida.
  • OperationNotAllowed – a relação não pode se conectar ao mesmo gêmeo digital.
  • ValidationFailed – o conteúdo da relação é inválido.
• 404 Não Encontrado
  • DigitalTwinNotFound - O gêmeo digital não foi encontrado.
  • TargetTwinNotFound - O destino do gêmeo digital da relação não foi encontrado.
• 412 Falha na Pré-condição
  • PreconditionFailed - Falha na verificação de pré-condição (If-Match ou If-None-Match).

PUT https://digitaltwins-hostname/digitaltwins/{id}/relationships/{relationshipId}?api-version=2023-10-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
id	path	True	string	A ID do gêmeo digital. A ID é exclusiva dentro do serviço e diferencia maiúsculas de minúsculas.
relationshipId	path	True	string	A ID da relação. A ID é exclusiva dentro do gêmeo digital e diferencia maiúsculas de minúsculas.
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-None-Match		string	Somente execute a operação se a entidade ainda não existir.
traceparent		string	Identifica a solicitação em um sistema de rastreamento distribuído.
tracestate		string	Fornece informações de identificação de rastreamento específicas do fornecedor e é um complemento para o rastreamentoparente.

Corpo da solicitação

Nome	Tipo	Description
relationship	object	Os dados da relação.

Respostas

Nome	Tipo	Description
200 OK	Relationship	Sucesso Headers ETag: string
Other Status Codes	ErrorResponse	Resposta padrão. Headers x-ms-error-code: string

Segurança

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Exemplos

Create a relationship

Create a relationship (with properties)

Create a relationship

Sample Request

HTTP

PUT https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31

{
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship"
}

Sample Response

Status code:

200

{
  "$relationshipId": "myRelationshipId",
  "$sourceId": "mySourceTwin",
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
}

Create a relationship (with properties)

Sample Request

HTTP

PUT https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31

{
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "relationshipProperty1": 1,
  "relationshipProperty2": "some value"
}

Sample Response

Status code:

200

{
  "$relationshipId": "myRelationshipId",
  "$sourceId": "mySourceTwin",
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "relationshipProperty1": 1,
  "relationshipProperty2": "some value",
  "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
}

Definições

Nome	Description
Error	Definição de erro.
ErrorResponse	Resposta de erro.
InnerError	Uma descrição de erro mais específica do que foi fornecida pelo erro que contém.

Error

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	Error[]	Detalhes do erro interno.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo homem do erro.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

Uma descrição de erro mais específica do que foi fornecida pelo erro que contém.

Nome	Tipo	Description
code	string	Um código de erro mais específico do que foi fornecido pelo erro que contém.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.