Partilhar via


Twins - DigitalTwins AddRelationship

Adiciona uma relação entre dois duplos digitais. Códigos de estado:

  • 200 OK
  • 400 Pedido Incorreto
    • InvalidArgument – o ID do duplo digital, o ID de relação ou o payload são inválidos.
    • InvalidRelationship – a relação é inválida.
    • OperationNotAllowed – a relação não consegue ligar ao mesmo duplo digital.
    • ValidationFailed – o conteúdo da relação é inválido.
  • 404 Não Encontrado
    • DigitalTwinNotFound - O duplo digital não foi encontrado.
    • TargetTwinNotFound - O destino do duplo digital da relação não foi encontrado.
  • Falha na Pré-condição 412
    • PreconditionFailed - A verificação de pré-condição (If-Match ou If-None-Match) falhou.
PUT https://digitaltwins-hostname/digitaltwins/{id}/relationships/{relationshipId}?api-version=2023-10-31

Parâmetros do URI

Name Em Necessário Tipo Description
id
path True

string

O ID do duplo digital. O ID é exclusivo no serviço e sensível às maiúsculas e minúsculas.

relationshipId
path True

string

O ID da relação. O ID é exclusivo no duplo digital e sensível às maiúsculas e minúsculas.

api-version
query True

string

A versão da API pedida.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-None-Match

string

Execute apenas a operação se a entidade ainda não existir.

traceparent

string

Identifica o pedido num sistema de rastreio distribuído.

tracestate

string

Fornece informações de identificação de rastreio específicas do fornecedor e é um complemento para o traceparent.

Corpo do Pedido

Name Tipo Description
relationship

object

Os dados da relação.

Respostas

Name Tipo Description
200 OK

Relationship

Com êxito

Headers

ETag: string

Other Status Codes

ErrorResponse

Resposta predefinida.

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

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

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

Sample Response

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

Create a relationship (with properties)

Sample Request

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

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

Sample Response

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

Definições

Name Description
Error

Definição de erro.

ErrorResponse

Resposta de erro.

InnerError

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

Error

Definição de erro.

Name Tipo Description
code

string

Código de erro específico do serviço que serve como subestado para o código de erro HTTP.

details

Error[]

Detalhes internos do erro.

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 por humanos do erro.

ErrorResponse

Resposta de erro.

Name Tipo Description
error

Error

Os detalhes do erro.

InnerError

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

Name Tipo Description
code

string

Um código de erro mais específico do que o 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.