1. 定義別エンティティ リソース

定義別エンティティ リソース

定義別エンティティ リソースには、指定されたエンティティ定義に関連付けられたエンティティのコレクションが含まれています。

このリソースは、GET メソッドのみサポートしています。

GET /api/entitydefinitions/{名前}/entities{?skip、take}

指定されたエンティティ定義に関連付けられているエンティティのコレクションを取得します。 応答には、エンティティ オブジェクトのコレクションが含まれています。

チャンク

1 つのチャンクに収まらないほど多くのエンティティがある場合は、次のチャンクを取得するためのリンクが記述されます。

範囲設定

take パラメーターを指定すると、返されるエンティティの数はそのパラメーター値 (最大で 100) に制限されます。 skip パラメーターを使用して、返されるエンティティの範囲を詳しく指定することもできます。

要求の例:

GET http://hostname/api/entitydefinitions/EntityDefinition1/entities
Host: hostname
Accept: application/json

応答の例:

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

{
    "items": [
        {
            "id":100,
                "properties":{
                    "Property1":"Some value",
                "Property2":42
            },
            "relations":...
            "self":{
                "href":"http://hostname/api/entities/1"
            }
        }
    ],
    "next",{
        "href":"http://hostname/api/entitydefinitions/EntityDefinition1/entities/?skip=25"
    }
    "returned_items":25,
    "self":{
        "href":"http://hostname/api/entitydefinitions/EntityDefinition1/entities"
    },
    "total_items":1245
}
この記事を改善するための提案がある場合は、 お知らせください!