エンティティ定義コレクション

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

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

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

サポートされている方法: GET、HEAD、POST

GET /api/entitydefinitions{?スキップ、取得}

ViewMode 'Extended' は、システム内のすべてのエンティティ定義を含むエンティティ定義コレクションオブジェクトを返します。ViewMode 'Basic' は、プロパティの限定されたサブセットを持つシステム内のすべてのエンティティ定義 (フィルターが適用されていない) を含むEntity Definition Basic Collection Objectを返します。

チャンキング

1つのチャンクに収まりきらないエンティティ定義がある場合は、次のチャンクを取得するためのリンクが含まれます。

まで

takeパラメータが指定されている場合、返されるエンティティ定義の数はそのパラメータに制限されます (最大100)。skipパラメーターを含めて、返されるエンティティ定義の範囲をさらに決定することもできます。

ビューモード

'viewMode' パラメータが指定されている場合、返されるプロパティのコレクションは変更されます。「基本」と「拡張」(デフォルト)の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/エンティティ定義

システム内のエンティティ定義のコレクションに新しいエンティティ定義を追加します。本文には完全なエンティティ定義オブジェクトが必要です。成功は、新しく作成されたリソースのURLを含む201 Created responseLocationヘッダーの1を返すことによって示されます。

注: 新しいエンティティ定義をポストする場合、プロパティ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

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