定義によるエンティティ

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

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

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

GET /api/entitydefinitions/{name}/entities{?skip,take}

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

次の表に、クエリパラメーターと関連情報の一覧を示します。

パラメーター	種類	情報
skip	整数	スキップする定義の数。
take	整数	返す定義の数。
filter	糸	追加のフィルター。
definitionsToLoad	糸	非推奨の場合は、definitionsToLoadByName.
definitionsToLoadByName	糸	定義名のコンマ区切りリスト。
definitionsToLoadById	糸	定義IDのコンマ区切りリスト。
viewMode	基本/拡張	表示モード。
loadPermissions	ブーリアン	読み込み権限のフラグ。
includeConditionalMembers	ブーリアン	条件付きメンバーを含めるためのフラグ。
excludeTaxonomyDefinitions	ブーリアン	分類の定義を除外するためのフラグ。
excludeSystemOwnedDefinitions	ブーリアン	システム所有の定義を除外するためのフラグ。

チャンキング

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
}

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