Models - DigitalTwinModels Update

Service:

Azure Digital Twins

API Version:

2023-10-31

Novedades los metadatos de un modelo. Códigos de estado:

• 204 No Content
• 400 - Solicitud incorrecta
  • InvalidArgument: el identificador del modelo no es válido.
  • JsonPatchInvalid: la revisión JSON proporcionada no es válida.
  • MissingArgument: no se proporcionó el identificador del modelo.
• 404 No encontrado
  • ModelNotFound: no se encontró el modelo.
• 409 Conflicto
  • ModelReferencesNotDecommissioned: el modelo hace referencia a los modelos que no se retiran.

PATCH https://digitaltwins-hostname/models/{id}?api-version=2023-10-31

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
id	path	True	string	Identificador del modelo. El identificador es único global y distingue mayúsculas de minúsculas.
api-version	query	True	string	La versión de API solicitada.

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
traceparent		string	Identifica la solicitud en un sistema de seguimiento distribuido.
tracestate		string	Proporciona información de identificación de seguimiento específica del proveedor y es un complemento de traceparent.

Cuerpo de la solicitud

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

Nombre	Tipo	Description
updateModel	object[]	Especificación de actualización descrita por la revisión JSON. Solo se puede reemplazar la propiedad retirada.

Respuestas

Nombre	Tipo	Description
204 No Content		Correcto
Other Status Codes	ErrorResponse	Respuesta predeterminada. Headers x-ms-error-code: string

Seguridad

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Ejemplos

Decommission a model

Sample Request

HTTP

PATCH https://digitaltwins-hostname/models/dtmi:com:example:Sample;1?api-version=2023-10-31

[
  {
    "op": "replace",
    "path": "/decommissioned",
    "value": true
  }
]

Sample Response

Status code:

204

Definiciones

Nombre	Description
Error	Definición de error.
ErrorResponse	Respuesta de error.
InnerError	Una descripción de error más específica de la proporcionada por el error contenedor.

Error

Definición de error.

Nombre	Tipo	Description
code	string	Código de error específico del servicio que actúa como subestado para el código de error HTTP.
details	Error[]	Detalles internos del error.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	Error	Los detalles del error.

InnerError

Una descripción de error más específica de la proporcionada por el error contenedor.

Nombre	Tipo	Description
code	string	Código de error más específico del proporcionado por el error contenedor.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.