Dela via


Models - DigitalTwinModels Add

Laddar upp en eller flera modeller. När ett fel inträffar laddas inga modeller upp. Statuskoder:

  • 201 Skapad
  • 400 Felaktig begäran
    • DTDLParserError – de modeller som tillhandahålls är inte giltiga DTDL.
    • InvalidArgument – modell-ID:t är ogiltigt.
    • LimitExceeded – Det maximala antalet modell-ID:n som tillåts i "dependenciesFor" har uppnåtts.
    • ModelVersionNotSupported – Den version av DTDL som används stöds inte.
  • 409 – Konflikt
    • ModelAlreadyExists – den angivna modellen finns redan.
POST https://digitaltwins-hostname/models?api-version=2023-10-31

URI-parametrar

Name I Obligatorisk Typ Description
api-version
query True

string

Den begärda API-versionen.

Begärandehuvud

Name Obligatorisk Typ Description
traceparent

string

Identifierar begäran i ett distribuerat spårningssystem.

tracestate

string

Tillhandahåller leverantörsspecifik spårningsidentifieringsinformation och är ett komplement till traceparent.

Begärandetext

Name Typ Description
models

object[]

En matris med modeller att lägga till.

Svar

Name Typ Description
201 Created

DigitalTwinsModelData[]

Klart

Other Status Codes

ErrorResponse

Standardsvar.

Headers

x-ms-error-code: string

Säkerhet

oauth2

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

Exempel

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
  }
]

Definitioner

Name Description
DigitalTwinsModelData

En modelldefinition och metadata för den modellen.

Error

Feldefinition.

ErrorResponse

Felsvar.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

DigitalTwinsModelData

En modelldefinition och metadata för den modellen.

Name Typ Standardvärde Description
decommissioned

boolean

False

Anger om modellen har inaktiverats. Inaktiverade modeller kan inte refereras till av nyligen skapade digitala tvillingar.

description

object

En språkkarta som innehåller de lokaliserade beskrivningarna som anges i modelldefinitionen.

displayName

object

En språkkarta som innehåller de lokaliserade visningsnamnen som anges i modelldefinitionen.

id

string

ID:t för modellen som anges i modelldefinitionen.

model

object

Modelldefinitionen.

uploadTime

string

Den tid då modellen laddades upp till tjänsten.

Error

Feldefinition.

Name Typ Description
code

string

Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.

details

Error[]

Intern felinformation.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

message

string

En mänsklig läsbar representation av felet.

ErrorResponse

Felsvar.

Name Typ Description
error

Error

Felinformationen.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

Name Typ Description
code

string

En mer specifik felkod än vad som angavs av det innehållande felet.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.