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


Models - DigitalTwinModels Add

Feltölt egy vagy több modellt. Hiba esetén a rendszer nem tölt fel modelleket. Állapotkódok:

  • 201 Létrehozva
  • 400 – Hibás kérés
    • DTDLParserError – A megadott modellek érvénytelen DTDL-nek számítanak.
    • InvalidArgument – A modellazonosító érvénytelen.
    • LimitExceeded – Elérte a "dependenciesFor" fájlban engedélyezett modellazonosítók maximális számát.
    • ModelVersionNotSupported – A használt DTDL-verzió nem támogatott.
  • 409 Ütközés
    • ModelAlreadyExists – A megadott modell már létezik.
POST https://digitaltwins-hostname/models?api-version=2023-10-31

URI-paraméterek

Name In Kötelező Típus Description
api-version
query True

string

A kért API-verzió.

Kérelem fejléce

Name Kötelező Típus Description
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 biztosít, és a nyomkövetési adatok kiegészítője.

Kérelem törzse

Name Típus Description
models

object[]

Hozzáadandó modellek tömbje.

Válaszok

Name Típus Description
201 Created

DigitalTwinsModelData[]

Siker

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 models

Sample Request

POST https://digitaltwins-hostname/models?api-version=2023-10-31

[
  {
    "@id": "dtmi:com:example:Sample;1",
    "@type": "Interface",
    "displayName": "Sample Interface",
    "contents": [
      {
        "@type": "Property",
        "name": "name",
        "displayName": "Sample instance name",
        "schema": "string"
      },
      {
        "@type": "Property",
        "name": "temp",
        "displayName": "Sample instance temperature",
        "schema": "integer"
      },
      {
        "@type": "Property",
        "name": "comfortIndex",
        "displayName": "Sample instance comfort index",
        "schema": "integer"
      }
    ],
    "@context": "dtmi:dtdl:context;2"
  }
]

Sample Response

[
  {
    "id": "dtmi:com:example:Sample;1",
    "displayName": {
      "en": "Sample Interface"
    },
    "uploadTime": "2022-02-28T00:30:00.1234567Z",
    "decommissioned": false
  }
]

Definíciók

Name Description
DigitalTwinsModelData

A modell definíciója és metaadatai.

Error

Hibadefiníció.

ErrorResponse

Hibaválasz.

InnerError

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

DigitalTwinsModelData

A modell definíciója és metaadatai.

Name Típus Alapértelmezett érték Description
decommissioned

boolean

False

Azt jelzi, hogy a modell leszerelt-e. A leszerelt modellekre az újonnan létrehozott digitális ikerpéldányok nem hivatkozhatnak.

description

object

Nyelvi térkép, amely a modelldefinícióban megadott honosított leírásokat tartalmazza.

displayName

object

Nyelvi térkép, amely a modelldefinícióban megadott honosított megjelenítendő neveket tartalmazza.

id

string

A modellnek a modelldefinícióban megadott azonosítója.

model

object

A modelldefiníció.

uploadTime

string

A modell szolgáltatásba való feltöltésének időpontja.

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ót 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 amelyet a hiba tartalmazott.

Name Típus Description
code

string

Pontosabb hibakód, mint amit a tartalmazó hiba adott meg.

innererror

InnerError

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