Twins - DigitalTwins GetComponent

Service:

Azure Digital Twins

API Version:

2023-10-31

Recupera um componente de um gêmeo digital. Códigos de status:

• 200 OK
• 400 Solicitação Inválida
  • InvalidArgument – a ID do gêmeo digital ou o caminho do componente é inválido.
• 404 Não Encontrado
  • DigitalTwinNotFound - O gêmeo digital não foi encontrado.
  • ComponentNotFound - O caminho do componente não foi encontrado.

GET https://digitaltwins-hostname/digitaltwins/{id}/components/{componentPath}?api-version=2023-10-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
componentPath	path	True	string	O nome do componente DTDL.
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 ao rastreamentoparente.

Respostas

Nome	Tipo	Description
200 OK	Component	Sucesso Headers ETag: string
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

Get a component in a digital twin

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "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": {
    "$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

Nome	Description
Error	Definição de erro.
ErrorResponse	Resposta de erro.
InnerError	Uma descrição de erro mais específica do que foi fornecida pelo erro que o 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 do erro.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

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

Nome	Tipo	Description
code	string	Um código de erro mais específico do que foi fornecido pelo erro que o contém.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.