Delen via


Models - DigitalTwinModels Add

Uploadt een of meer modellen. Wanneer er een fout optreedt, worden er geen modellen geüpload. Statuscodes:

  • 201 Gemaakt
  • 400 Ongeldige aanvraag
    • DTDLParserError: de opgegeven modellen zijn geen geldige DTDL.
    • InvalidArgument: de model-id is ongeldig.
    • LimitExceeded: het maximum aantal model-id's dat is toegestaan in 'dependenciesFor' is bereikt.
    • ModelVersionNotSupported - De gebruikte versie van DTDL wordt niet ondersteund.
  • 409 Conflict
    • ModelAlreadyExists : het opgegeven model bestaat al.
POST https://digitaltwins-hostname/models?api-version=2023-10-31

URI-parameters

Name In Vereist Type Description
api-version
query True

string

De aangevraagde API-versie.

Aanvraagkoptekst

Name Vereist Type Description
traceparent

string

Identificeert de aanvraag in een gedistribueerd traceringssysteem.

tracestate

string

Biedt leverancierspecifieke traceringsidentificatie-informatie en is een aanvulling op traceringsouder.

Aanvraagbody

Name Type Description
models

object[]

Een matrix met toe te voegen modellen.

Antwoorden

Name Type Description
201 Created

DigitalTwinsModelData[]

Geslaagd

Other Status Codes

ErrorResponse

Standaardantwoord.

Headers

x-ms-error-code: string

Beveiliging

oauth2

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

Voorbeelden

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

Definities

Name Description
DigitalTwinsModelData

Een modeldefinitie en metagegevens voor dat model.

Error

Foutdefinitie.

ErrorResponse

Foutreactie.

InnerError

Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

DigitalTwinsModelData

Een modeldefinitie en metagegevens voor dat model.

Name Type Standaardwaarde Description
decommissioned

boolean

False

Geeft aan of het model buiten gebruik is gesteld. Naar buiten gebruik gestelde modellen kan niet worden verwezen door nieuwe digitale dubbels.

description

object

Een taaltoewijzing met de gelokaliseerde beschrijvingen zoals opgegeven in de modeldefinitie.

displayName

object

Een taalkaart met de gelokaliseerde weergavenamen zoals opgegeven in de modeldefinitie.

id

string

De id van het model zoals opgegeven in de modeldefinitie.

model

object

De modeldefinitie.

uploadTime

string

Het tijdstip waarop het model is geüpload naar de service.

Error

Foutdefinitie.

Name Type Description
code

string

Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.

details

Error[]

Interne foutdetails.

innererror

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.

message

string

Een door mensen leesbare weergave van de fout.

ErrorResponse

Foutreactie.

Name Type Description
error

Error

De foutdetails.

InnerError

Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

Name Type Description
code

string

Een specifiekere foutcode dan is opgegeven door de betreffende fout.

innererror

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.