Models - DigitalTwinModels Update

Service:

Azure Digital Twins

API Version:

2023-10-31

Обновления метаданные модели. Коды состояния:

• 204 No Content (содержимое отсутствует)
• 400 — недопустимый запрос
  • InvalidArgument — недопустимый идентификатор модели.
  • JsonPatchInvalid — предоставленное исправление JSON является недопустимым.
  • MissingArgument — идентификатор модели не указан.
• 404 — не найдено
  • ModelNotFound — модель не найдена.
• 409. Конфликт
  • ModelReferencesNotDecommissioned — модель относится к моделям, которые не выведены из эксплуатации.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
id	path	True	string	Идентификатор модели. Идентификатор глобально уникален и учитывает регистр.
api-version	query	True	string	Запрошенная версия API.

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
traceparent		string	Определяет запрос в распределенной системе трассировки.
tracestate		string	Предоставляет сведения об идентификации трассировки для конкретного поставщика и является компаньоном для traceparent.

Текст запроса

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

Имя	Тип	Описание
updateModel	object[]	Спецификация обновления, описанная в json Patch. Можно заменить только списанное свойство.

Ответы

Имя	Тип	Описание
204 No Content		Успешное завершение
Other Status Codes	ErrorResponse	Ответ по умолчанию. Headers x-ms-error-code: string

Безопасность

oauth2

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

Примеры

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

Определения

Имя	Описание
Error	Определение ошибки.
ErrorResponse	Ответ об ошибке.
InnerError	Более конкретное описание ошибки, чем указано в содержающей ошибке.

Error

Определение ошибки.

Имя	Тип	Описание
code	string	Код ошибки службы, который служит подсостояние для кода ошибки HTTP.
details	Error[]	Сведения о внутренней ошибке.
innererror	InnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.

ErrorResponse

Ответ об ошибке.

Имя	Тип	Описание
error	Error	Сведения об ошибке.

InnerError

Более конкретное описание ошибки, чем указано в содержающей ошибке.

Имя	Тип	Описание
code	string	Более конкретный код ошибки, чем указано в содержающей ошибке.
innererror	InnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.