Twins - DigitalTwins Update

Updates kembar digital. Kode status:

  • 204 Tidak Ada Konten
  • 400 Permintaan Buruk
    • InvalidArgument - Id kembar digital atau payload tidak valid.
    • JsonPatchInvalid - Patch JSON yang disediakan tidak valid.
    • ValidationFailed - Menerapkan patch menghasilkan kembaran digital yang tidak valid.
  • 404 Tidak Ditemukan
    • DigitalTwinNotFound - Kembar digital tidak ditemukan.
  • Prasyarat 412 Gagal
    • PreconditionFailed - Pemeriksaan prasyarat (If-Match atau If-None-Match) gagal.
PATCH https://digitaltwins-hostname/digitaltwins/{id}?api-version=2023-10-31

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
id
path True

string

Id kembar digital. Id unik dalam layanan dan peka huruf besar/kecil.

api-version
query True

string

Versi API yang diminta.

Header Permintaan

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

Nama Diperlukan Jenis Deskripsi
If-Match

string

Hanya lakukan operasi jika etag entitas cocok dengan salah satu etag yang disediakan atau * disediakan.

traceparent

string

Mengidentifikasi permintaan dalam sistem pelacakan terdistribusi.

tracestate

string

Menyediakan informasi identifikasi jejak khusus vendor dan merupakan pendamping untuk melacak.

Isi Permintaan

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

Nama Jenis Deskripsi
patchDocument

object[]

Spesifikasi pembaruan yang dijelaskan oleh JSON Patch. Updates ke nilai properti dan elemen $model mungkin terjadi dalam permintaan yang sama. Operasi terbatas pada penambahan, penggantian, dan penghapusan.

Respons

Nama Jenis Deskripsi
204 No Content

Berhasil

Headers

ETag: string

Other Status Codes

ErrorResponse

Respons default.

Headers

x-ms-error-code: string

Keamanan

oauth2

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

Contoh

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

Definisi

Nama Deskripsi
Error

Definisi kesalahan.

ErrorResponse

Respons kesalahan.

InnerError

Deskripsi kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.

Error

Definisi kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan khusus layanan yang berfungsi sebagai substatus untuk kode kesalahan HTTP.

details

Error[]

Detail kesalahan internal.

innererror

InnerError

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

message

string

Representasi kesalahan yang dapat dibaca manusia.

ErrorResponse

Respons kesalahan.

Nama Jenis Deskripsi
error

Error

Detail kesalahan.

InnerError

Deskripsi kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.

Nama Jenis Deskripsi
code

string

Kode kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.

innererror

InnerError

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.