Twins - DigitalTwins AddRelationship

Service:

Azure Digital Twins

API Version:

2023-10-31

2 つのデジタル ツイン間のリレーションシップを追加します。 状態コード:

• 200 OK
• 400 Bad Request
  • InvalidArgument - デジタル ツイン ID、リレーションシップ ID、またはペイロードが無効です。
  • InvalidRelationship - リレーションシップが無効です。
  • OperationNotAllowed - リレーションシップを同じデジタル ツインに接続できません。
  • ValidationFailed - リレーションシップの内容が無効です。
• 404 見つかりません
  • DigitalTwinNotFound - デジタル ツインが見つかりませんでした。
  • TargetTwinNotFound - リレーションシップのデジタル ツイン ターゲットが見つかりませんでした。
• 412 Precondition Failed
  • PreconditionFailed - 前提条件チェック (If-Match または If-None-Match) が失敗しました。

PUT https://digitaltwins-hostname/digitaltwins/{id}/relationships/{relationshipId}?api-version=2023-10-31

URI パラメーター

名前	/	必須	型	説明
id	path	True	string	デジタル ツインの ID。 ID はサービス内で一意であり、大文字と小文字が区別されます。
relationshipId	path	True	string	リレーションシップの ID。 ID は、デジタル ツイン内で一意であり、大文字と小文字が区別されます。
api-version	query	True	string	要求された API バージョン。

要求ヘッダー

名前	必須	型	説明
If-None-Match		string	エンティティがまだ存在しない場合にのみ、操作を実行します。
traceparent		string	分散トレース システム内の要求を識別します。
tracestate		string	ベンダー固有のトレース識別情報を提供し、traceparent に対応しています。

要求本文

名前	型	説明
relationship	object	リレーションシップのデータ。

応答

名前	型	説明
200 OK	Relationship	Success Headers ETag: string
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

例

Create a relationship

Create a relationship (with properties)

Create a relationship

Sample Request

HTTP

PUT https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31

{
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship"
}

Sample Response

Status code:

200

{
  "$relationshipId": "myRelationshipId",
  "$sourceId": "mySourceTwin",
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
}

Create a relationship (with properties)

Sample Request

HTTP

PUT https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31

{
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "relationshipProperty1": 1,
  "relationshipProperty2": "some value"
}

Sample Response

Status code:

200

{
  "$relationshipId": "myRelationshipId",
  "$sourceId": "mySourceTwin",
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "relationshipProperty1": 1,
  "relationshipProperty2": "some value",
  "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
}

定義

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

Error

エラー定義。

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

ErrorResponse

エラー応答。

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

InnerError

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

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