Twins - DigitalTwins ListIncomingRelationships

Service:

Azure Digital Twins

API Version:

2023-10-31

Recupera toda a relação de entrada para um gêmeo digital. Códigos de status:

• 200 OK
• 400 Solicitação Inválida
  • InvalidArgument - A ID do gêmeo digital é inválida.
• 404 Não Encontrado
  • DigitalTwinNotFound - O gêmeo digital não foi encontrado.

GET https://digitaltwins-hostname/digitaltwins/{id}/incomingrelationships?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.
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
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.

Respostas

Nome	Tipo	Description
200 OK	IncomingRelationshipCollection	Sucesso
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

List incoming relationships

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "firstRelationshipId",
      "$relationshipName": "myRelationship",
      "$relationshipLink": "/digitaltwins/mySourceTwin/relationships/myRelationship/firstRelationshipId"
    },
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "secondRelationshipId",
      "$relationshipName": "myRelationship",
      "$relationshipLink": "/digitaltwins/mySourceTwin/relationships/myRelationship/secondRelationshipId"
    }
  ],
  "nextLink": "url-to-next-page"
}

Definições

Nome	Description
Error	Definição de erro.
ErrorResponse	Resposta de erro.
IncomingRelationship	Uma relação de entrada.
IncomingRelationshipCollection	Uma coleção de relações de entrada que relacionam gêmeos digitais juntos.
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.

IncomingRelationship

Uma relação de entrada.

Nome	Tipo	Description
$relationshipId	string	Uma cadeia de caracteres fornecida pelo usuário que representa a ID dessa relação, exclusiva no contexto do gêmeo digital de origem, ou seja, sourceId + relationshipId é exclusiva no contexto do serviço.
$relationshipLink	string	Vincular à relação, a ser usada para exclusão.
$relationshipName	string	O nome da relação.
$sourceId	string	A ID do gêmeo digital de origem.

IncomingRelationshipCollection

Uma coleção de relações de entrada que relacionam gêmeos digitais juntos.

Nome	Tipo	Description
nextLink	string	Um URI para recuperar a próxima página de objetos.
value	IncomingRelationship[]	Uma relação de entrada.

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.