Twins - DigitalTwins ListRelationships
Recupera as relações de 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}/relationships?api-version=2023-10-31
GET https://digitaltwins-hostname/digitaltwins/{id}/relationships?relationshipName={relationshipName}&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. |
relationship
|
query |
string |
O nome da relação. |
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 |
Sucesso |
|
Other Status Codes |
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 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
Nome | Description |
---|---|
Error |
Definição de erro. |
Error |
Resposta de erro. |
Inner |
Uma descrição de erro mais específica do que foi fornecida pelo erro que contém. |
Relationship |
Uma coleção de relações que relacionam gêmeos digitais. |
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 |
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 |
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 |
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 gêmeos digitais.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
Um URI para recuperar a próxima página de objetos. |
value |
object[] |
Os objetos de relação. |
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de