1. エンティティ定義コレクション リソース

エンティティ定義コレクション リソース

エンティティ定義コレクション リソースには、システム内に存在するすべてのエンティティ定義が含まれています。

サポートされているメソッド: GET、HEAD、POST

GET /api/entitydefinitions{?skip、take}

ViewMode を「Extended」に設定すると、システム内のすべてのエンティティ定義が含まれているエンティティ定義コレクション オブジェクトが返されます。 ViewMode を「Basic」に設定すると、システム内のすべてのエンティティ定義 (フィルターが適用されていない) と制限されたプロパティのサブセットが含まれているエンティティ定義基本コレクション オブジェクトが返されます。

チャンク

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

範囲設定

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

ViewMode

「viewMode」パラメーターが指定されている場合、返されるプロパティのコレクションが変化します。 「Basic」と「Extended」(既定) の 2 つのオプションを使用できます。 Basic を指定すると、プロパティ (id、name、labels) を持つページングされていない Extended のサブセットが返されます。

フィルター

「filter」パラメーターを使用すると、返されるエンティティ定義をブール値のプロパティ (IsSystemOwned、IsTaxonomyItemDefinition など) でフィルタリングできます。 フィルターでは大文字と小文字は区別されません。 例: &filter=issystemowned==true

要求の例:

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

応答の例:

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

{
    "items": [
        Entity Definition Objects
    ],
    "next",{
        "href":"http://hostname/api/entitydefinitions?skip=25"
    },
    "returned_items":25,
    "self":{
        "href":"http://hostname/api/entitydefinitions"
    },
    "total_items":33
}

POST /api/entitydefinitions

システム内のエンティティ定義のコレクションに新しいエンティティ定義を追加します。 本文では、完全なエンティティ定義オブジェクトが予期されます。 処理に成功すると、201 Created response が返されます。この場合、Location ヘッダーには、新しく作成されたリソースの URL が含まれます。

注: 新しいエンティティ定義を投稿する場合、id、self、entities の各プロパティは無視されるため省略できます。

要求の例:

POST http://hostname/api/entitydefinitions
Host: hostname
Content-Type: application/json

{
    "name":"New entity definition",
    "member_groups":[
        {
            "name":"New member group",
            "labels":{
                "en-US":"New member group",
                "nl-BE":"Nieuwe onderdeel groep"
            },
            "members":[
                {
                    "type":"String"
                    "name":"New string property"
                },
                ...
            ]
        },
        ...
    ]
}

応答の例:

HTTP/1.1 201 Created
Location: http://hostname/api/entitydefinitons/New%20entity%20definition
この記事を改善するための提案がある場合は、 お知らせください!