1. 部分エンティティ リソース

部分エンティティ リソース

部分エンティティ リソースは、エンティティ リソースと同様に機能しますが、プロパティの一部とリレーション リンクの一部のみを返す点が異なります。

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

GET /api/entities/id?groups=group,group&members=member,member

クエリ パラメーター groups と members で指定されたプロパティとリレーション リンクに限定して、エンティティの状態を収めた部分エンティティ オブジェクトを返します。

要求の例:

GET http://<hostname>/api/entities/1?members=Property1,Parent
Host: hostname
Accept: application/json

応答の例:

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

{
"id":100,
"properties":{
"Property1":"Some value"
},
"relations":{
"Parent":{
"href":"http://<hostname>/api/entities/1/relations/Parent"
}
},
"self":{
"href":"http://<hostname>/api/entities/1"
},
"entitydefinition":{
"href":"http://<hostname>/api/entitydefinitions/EntityDefinition1"
}
}
この記事を改善するための提案がある場合は、 お知らせください!