Models - DigitalTwinModels Add

Service:

Azure Digital Twins

API Version:

2023-10-31

1 つ以上のモデルをアップロードします。 エラーが発生した場合、モデルはアップロードされません。 状態コード:

• 201 Created
• 400 Bad Request
  • DTDLParserError - 指定されたモデルが有効な DTDL ではありません。
  • InvalidArgument - モデル ID が無効です。
  • LimitExceeded - 'dependenciesFor' で許可されているモデル ID の最大数に達しました。
  • ModelVersionNotSupported - 使用される DTDL のバージョンはサポートされていません。
• 409 競合
  • ModelAlreadyExists - 指定されたモデルは既に存在します。

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

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	要求された API バージョン。

要求ヘッダー

名前	必須	型	説明
traceparent		string	分散トレース システム内の要求を識別します。
tracestate		string	ベンダー固有のトレース識別情報を提供し、トレース親のコンパニオンです。

要求本文

名前	型	説明
models	object[]	追加するモデルの配列。

応答

名前	型	説明
201 Created	DigitalTwinsModelData[]	Success
Other Status Codes	ErrorResponse	既定の応答。 Headers x-ms-error-code: string

セキュリティ

oauth2

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

例

Add models

Sample Request

HTTP

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

Status code:

201

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

定義

名前	説明
DigitalTwinsModelData	そのモデルのモデル定義とメタデータ。
Error	エラー定義。
ErrorResponse	エラー応答。
InnerError	含まれているエラーによって提供されたよりも具体的なエラーの説明。

DigitalTwinsModelData

そのモデルのモデル定義とメタデータ。

名前	型	既定値	説明
decommissioned	boolean	False	モデルが使用停止になっているかどうかを示します。 使用停止されたモデルは、新しく作成されたデジタル ツインでは参照できません。
description	object		モデル定義で指定されたローカライズされた説明を含む言語マップ。
displayName	object		モデル定義で指定されたローカライズされた表示名を含む言語マップ。
id	string		モデル定義で指定されたモデルの ID。
model	object		モデル定義。
uploadTime	string		モデルがサービスにアップロードされた時刻。

Error

エラー定義。

名前	型	説明
code	string	HTTP エラー コードのサブステータスとして機能するサービス固有のエラー コード。
details	Error[]	内部エラーの詳細。
innererror	InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。
message	string	エラーの人間が判読できる表現。

ErrorResponse

エラー応答。

名前	型	説明
error	Error	エラーの詳細です。

InnerError

含まれているエラーによって提供されたよりも具体的なエラーの説明。

名前	型	説明
code	string	含まれているエラーによって提供されたよりも具体的なエラー コード。
innererror	InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。