1. エンティティ リレーション リソース

エンティティ リレーション リソース

エンティティの各リレーションは、関連するエンティティへのすべての参照を含むリソースを定義します。このリソースは、関連する各エンティティをエンティティに格納する順序も伝えます。

GET、HEAD、PUT の各メソッドを使用できます。

GET /api/entities/id/relations/relation

関連するエンティティへのすべての参照が含まれるエンティティ リレーション オブジェクトを返します。

要求の例:

GET http://<hostname>/api/entities/1/relations/R1
Host: hostname
Accept: application/json

応答の例:

HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
ETag: "hash string"

{
"children":[
{
"href":"http://<hostname>/entities/2"
},
{
"href":"http://<hostname>/entities/3"
}
],
"self":{
"href":"http://<hostname>/entities/1/relations/R1"
}
}

PUT /api/entities/id/relations/relation

関連するエンティティの状態を更新します。すべてのリレーションが更新され、それらが表示される順序は維持されます。

ヒント: システムは、リレーションの有効な ID を識別しません。したがって、間違ったオブジェクト ID でリレーションを設定してしまう可能性もあります。リレーションに設定されている ID が正しいことを確認するのは開発者の責任です。リレーションに間違った ID が割り当てられている場合、UI には値が表示されないため、ユーザーの視点からは、間違ったデータが見えないことになります。

要求の例:

PUT http://<hostname>/api/entities/1/relations/R1
Host: hostname
Content-Type: application/json

{
"children":[
{
"href":"http://<hostname>/entities/2"
}
],
"self":{
"href":"http://<hostname>/entities/1/relations/R1"
}
}

応答の例:

HTTP/1.1 204 No Content
この記事を改善するための提案がある場合は、 お知らせください!