Models - DigitalTwinModels Update

Service:

Azure Digital Twins

API Version:

2023-10-31

Aktualizacje metadanych modelu. Kody stanu:

• 204 Brak zawartości
• 400 Nieprawidłowe żądanie
  • InvalidArgument — identyfikator modelu jest nieprawidłowy.
  • JsonPatchInvalid — podana poprawka JSON jest nieprawidłowa.
  • MissingArgument — nie podano identyfikatora modelu.
• 404 — Nie znaleziono
  • ModelNotFound — nie znaleziono modelu.
• 409 Konflikt
  • ModelReferencesNotDecommissioned — model odwołuje się do modeli, które nie są likwidowane.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
id	path	True	string	Identyfikator modelu. Identyfikator jest globalnie unikatowy i uwzględnia wielkość liter.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
traceparent		string	Identyfikuje żądanie w rozproszonym systemie śledzenia.
tracestate		string	Dostarcza informacje identyfikacyjne śledzenia specyficzne dla dostawcy i jest towarzyszem śledzenia rodziców.

Treść żądania

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

Nazwa	Typ	Opis
updateModel	object[]	Specyfikacja aktualizacji opisana przez poprawkę JSON. Można zamienić tylko zlikwidowaną właściwość.

Odpowiedzi

Nazwa	Typ	Opis
204 No Content		Powodzenie
Other Status Codes	ErrorResponse	Odpowiedź domyślna. Headers x-ms-error-code: string

Zabezpieczenia

oauth2

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

Przykłady

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

Definicje

Nazwa	Opis
Error	Definicja błędu.
ErrorResponse	Odpowiedź na błąd.
InnerError	Bardziej szczegółowy opis błędu niż został podany przez błąd zawierający.

Error

Definicja błędu.

Nazwa	Typ	Opis
code	string	Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP.
details	Error[]	Szczegóły błędu wewnętrznego.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Szczegóły błędu.

InnerError

Bardziej szczegółowy opis błędu niż został podany przez błąd zawierający.

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.