Twins - DigitalTwins UpdateComponent

Service:

Azure Digital Twins

API Version:

2023-10-31

Atualizações um componente em um gêmeo digital. Códigos de status:

• 204 Sem Conteúdo
• 400 Solicitação Inválida
  • InvalidArgument - A ID do gêmeo digital, o caminho do componente ou a carga são inválidos.
  • JsonPatchInvalid – o patch JSON fornecido é inválido.
  • ValidationFailed – a aplicação do patch resulta em um gêmeo digital inválido.
• 404 Não Encontrado
  • DigitalTwinNotFound - O gêmeo digital não foi encontrado.
• 412 Falha na Pré-condição
  • PreconditionFailed - Falha na verificação de pré-condição (If-Match ou If-None-Match).

PATCH 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

Media Types: "application/json-patch+json"

Nome	Obrigatório	Tipo	Description
If-Match		string	Execute a operação somente se a etag da entidade corresponder a uma das etags fornecidas ou * for fornecida.
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.

Corpo da solicitação

Media Types: "application/json-patch+json"

Nome	Tipo	Description
patchDocument	object[]	Uma especificação de atualização descrita pelo Patch JSON. Atualizações a valores de propriedade e elementos $model podem ocorrer na mesma solicitação. As operações são limitadas para adicionar, substituir e remover.

Respostas

Nome	Tipo	Description
204 No Content		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

Update a component in a digital twin

Update a component in a digital twin (multiple updates)

Update a component in a digital twin

Sample Request

HTTP

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

[
  {
    "op": "add",
    "path": "/property",
    "value": 1
  }
]

Sample Response

Status code:

204

Update a component in a digital twin (multiple updates)

Sample Request

HTTP

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

[
  {
    "op": "add",
    "path": "/property1",
    "value": 1
  },
  {
    "op": "replace",
    "path": "/$metadata/property1/sourceTime",
    "value": "2022-05-31T12:00:01.000125009Z"
  },
  {
    "op": "remove",
    "path": "/property2"
  },
  {
    "op": "replace",
    "path": "/property3/subProperty1",
    "value": "new value"
  }
]

Sample Response

Status code:

204

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

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.