Partilhar via


Twins - DigitalTwins Update

Atualizações um duplo digital. Códigos de estado:

  • 204 Sem Conteúdo
  • 400 Pedido Incorreto
    • InvalidArgument - O ID ou payload do duplo digital é inválido.
    • JsonPatchInvalid - O Patch JSON fornecido é inválido.
    • ValidationFailed - Aplicar o patch resulta num duplo digital inválido.
  • 404 Não Encontrado
    • DigitalTwinNotFound - O duplo digital não foi encontrado.
  • Falha na Pré-condição 412
    • PreconditionFailed - A verificação de pré-condição (If-Match ou If-None-Match) falhou.
PATCH 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

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

Name Necessário Tipo Description
If-Match

string

Execute apenas a operação se o etag da entidade corresponder a um dos etags fornecidos ou * for fornecido.

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.

Corpo do Pedido

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

Name Tipo Description
patchDocument

object[]

Uma especificação de atualização descrita por JSON Patch. Atualizações a valores de propriedade e $model elementos podem ocorrer no mesmo pedido. As operações estão limitadas a adicionar, substituir e remover.

Respostas

Name Tipo Description
204 No Content

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

Update a digital twin
Update a digital twin (multiple updates)

Update a digital twin

Sample Request

PATCH https://digitaltwins-hostname/digitaltwins/myNewTwinId?api-version=2023-10-31

[
  {
    "op": "replace",
    "path": "/property1",
    "value": 1
  }
]

Sample Response

Update a digital twin (multiple updates)

Sample Request

PATCH https://digitaltwins-hostname/digitaltwins/myNewTwinId?api-version=2023-10-31

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

Sample Response

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.