Megosztás a következőn keresztül:


Twins - DigitalTwins Add

Digitális ikerpéldányt ad hozzá vagy cserél le. Állapotkódok:

  • 200 OK
  • 400 Hibás kérelem
    • InvalidArgument – A digitális ikerpéldány azonosítója vagy hasznos adata érvénytelen.
    • ModelDecommissioned – A digitális ikerpéldány modellje leszerelve.
    • TwinLimitReached – Elérte az engedélyezett digitális ikerpéldányok maximális számát.
    • ValidationFailed – A digitális ikerpéldány hasznos adatai érvénytelenek.
  • 412 Az előfeltétel nem sikerült
    • PreconditionFailed – Az előfeltételek ellenőrzése (If-Match vagy If-None-Match) sikertelen volt.
PUT https://digitaltwins-hostname/digitaltwins/{id}?api-version=2023-10-31

URI-paraméterek

Name In Kötelező Típus Description
id
path True

string

A digitális ikerpéldány azonosítója. Az azonosító egyedi a szolgáltatáson belül, és megkülönbözteti a kis- és nagybetűk megkülönböztetése.

api-version
query True

string

A kért API-verzió.

Kérelem fejléce

Name Kötelező Típus Description
If-None-Match

string

Csak akkor hajtsa végre a műveletet, ha az entitás még nem létezik.

traceparent

string

Azonosítja a kérést egy elosztott nyomkövetési rendszerben.

tracestate

string

Szállítóspecifikus nyomkövetési azonosítási információkat nyújt, és a nyomkövetési adatok kísérője.

Kérelem törzse

Name Típus Description
twin

object

A hozzáadandó digitális ikerpéldány. Ha meg van adva, a $dtId tulajdonság figyelmen kívül lesz hagyva.

Válaszok

Name Típus Description
200 OK

DigitalTwin

Siker

Headers

ETag: string

Other Status Codes

ErrorResponse

Alapértelmezett válasz.

Headers

x-ms-error-code: string

Biztonság

oauth2

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

Példák

Add a digital twin
Add a digital twin (with properties and components)

Add a digital twin

Sample Request

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

{
  "$metadata": {
    "$model": "dtmi:com:example:interfaces:interfaceName;1"
  }
}

Sample Response

{
  "$dtId": "myNewTwinId",
  "$metadata": {
    "$model": "dtmi:com:example:interfaces:interfaceName;1",
    "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
  }
}

Add a digital twin (with properties and components)

Sample Request

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


{
  "$metadata": {
    "$model": "dtmi:com:example:interfaces:interfaceName;1",
    "property1": {
      "sourceTime": "2022-05-31T12:00:01.000125009Z"
    }
  },
  "property1": 1,
  "property2": {
    "subProperty1": "some value",
    "subProperty2": "some other value"
  },
  "component1": {
    "$metadata": {
      "componentProperty": {
        "sourceTime": "2022-05-31T12:00:00.000125009Z"
      }
    },
    "componentProperty": "some value"
  }
}

Sample Response

{
  "$dtId": "myNewTwinId",
  "$etag": "W/\"9c2876c2-aff0-40b3-9fba-0c6be9d020a6\"",
  "property1": 1,
  "property2": {
    "subProperty1": "some value",
    "subProperty2": "some other value"
  },
  "component1": {
    "componentProperty": "some value",
    "$metadata": {
      "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
      "componentProperty": {
        "lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
        "sourceTime": "2022-05-31T12:00:01.000125009Z"
      }
    }
  },
  "$metadata": {
    "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
    "$model": "dtmi:com:example:interfaces:interfaceName;1",
    "property1": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
      "sourceTime": "2022-05-31T12:00:01.000125009Z"
    },
    "property2": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    }
  }
}

Definíciók

Name Description
Error

Hibadefiníció.

ErrorResponse

Hibaválasz.

InnerError

Pontosabb hibaleírás, mint amit a hiba tartalmazott.

Error

Hibadefiníció.

Name Típus Description
code

string

Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.

details

Error[]

Belső hiba részletei.

innererror

InnerError

Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.

message

string

A hiba emberi olvasásra alkalmas ábrázolása.

ErrorResponse

Hibaválasz.

Name Típus Description
error

Error

A hiba részletei.

InnerError

Pontosabb hibaleírás, mint amit a hiba tartalmazott.

Name Típus Description
code

string

Pontosabb hibakód, mint amit a hiba tartalmazott.

innererror

InnerError

Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.