1. REST API

エンティティ定義

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

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

システム内の各エンティティ定義は、エンティティ定義リソースによって表され、エンティティ定義の状態を取得したり、更新および削除したりするために使用できます。

サポートされている方法:GETHEADPUTDELETE

GET /api/entitydefinitions/名前

エンティティ定義の状態を含む エンティティ定義オブジェクト を返します。

リクエストの例:

GET http://<hostname>/api/entitydefinitions/EntityDefinition1
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":298,
    "name":"EntityDefinition1",
    "member_groups":[
        {
            "name":"New member group",
            "labels":{
                "en-US":"New member group",
                "nl-BE":"Nieuwe onderdeel groep"
            },
            "members":[
                {
                    "type":"String"
                    "name":"New string property"
                },
                ...
            ]
        },
        ...
    ],
    "self":{
        "href":"http://<hostname>/api/entitydefinitions/EntityDefinition1"
    },
    "entities":{
        "href":"http://<hostname>/api/entitydefinitions/EntityDefinition1/entities"
    }
}

/api/entitydefinitions/nameをPUT

エンティティ定義を、要求で送信された状態で更新します。成功した場合、サーバは204 No Contentで応答します。要求本文には エンティティ定義オブジェクトが含まれている必要があり、すべてのプロパティが必要です。プロパティが存在しない場合、その値は削除されます。含まれていないメンバーは削除されます。

リクエストの例:

PUT http://<hostname>/api/entitydefinitions/EntityDefinition1
Host: hostname
Content-Type: application/json

{
    "member_groups":[
        {
            "labels":{
                "nl-NL":"Nieuwe onderdeel groep"
            }
        }
    ]
}

応答の例

HTTP/1.1 204 No Content

DELETE /api/entitydefinitions/name

エンティティ定義を削除します。成功した場合、サーバは204 No Contentで応答します。

リクエストの例:

DELETE http://<hostname>/api/entitydefinitions/EntityDefinition1
Host: hostname

応答の例:

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