Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Obtém 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}?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.

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	DigitalTwin	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

Get a digital twin by id

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "$dtId": "myTwinId",
  "$etag": "W/\"9c2876c2-aff0-40b3-9fba-0c6be9d020a6\"",
  "property1": 1,
  "property2": {
    "subProperty1": "some value",
    "subProperty2": "some other value"
  },
  "component1": {
    "componentProperty": "some value",
    "$metadata": {
      "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
      "componentProperty": {
        "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
      }
    }
  },
  "$metadata": {
    "$model": "dtmi:com:example:interfaces:interfaceName;1",
    "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
    "property1": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    },
    "property2": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    }
  }
}

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.

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.