Partilhar via


Twins - DigitalTwins ListRelationships

Obtém as relações de um duplo digital. Códigos de estado:

  • 200 OK
  • 400 Pedido Incorreto
    • InvalidArgument - O ID do duplo digital é inválido.
  • 404 Não Encontrado
    • DigitalTwinNotFound - O duplo digital não foi encontrado.
GET https://digitaltwins-hostname/digitaltwins/{id}/relationships?api-version=2023-10-31
GET https://digitaltwins-hostname/digitaltwins/{id}/relationships?relationshipName={relationshipName}&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.

api-version
query True

string

A versão da API pedida.

relationshipName
query

string

O nome da relação.

Cabeçalho do Pedido

Name Necessário Tipo Description
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.

Respostas

Name Tipo Description
200 OK

RelationshipCollection

Com êxito

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

List relationships
List relationships by name

List relationships

Sample Request

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

Sample Response

{
  "value": [
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "firstRelationshipId",
      "$targetId": "targetTwinId",
      "$relationshipName": "myRelationship",
      "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
      "property": "value"
    },
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "secondRelationshipId",
      "$targetId": "targetTwinId",
      "$relationshipName": "myRelationship",
      "$etag": "W/\"2552a0a7-0666-4d5e-a67f-ece5b9b81fe0\"",
      "property": "value"
    }
  ],
  "nextLink": "url-to-next-page"
}

List relationships by name

Sample Request

GET https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships?relationshipName=myRelationship&api-version=2023-10-31

Sample Response

{
  "value": [
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "firstRelationshipId",
      "$targetId": "targetTwinId",
      "$relationshipName": "myRelationship",
      "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
      "property": "value"
    },
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "secondRelationshipId",
      "$targetId": "targetTwinId",
      "$relationshipName": "myRelationship",
      "$etag": "W/\"2552a0a7-0666-4d5e-a67f-ece5b9b81fe0\"",
      "property": "value"
    }
  ],
  "nextLink": "url-to-next-page"
}

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 fornecida pelo erro que contém.

RelationshipCollection

Uma coleção de relações que relacionam duplos digitais.

Error

Definição de erro.

Name Tipo Description
code

string

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

details

Error[]

Detalhes de erro internos.

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 fornecida 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.

RelationshipCollection

Uma coleção de relações que relacionam duplos digitais.

Name Tipo Description
nextLink

string

Um URI para obter a página seguinte de objetos.

value

object[]

Os objetos de relação.