ケース フィールド

テスト ケースのカスタム フィールドに関する情報を取得するには、次の API メソッドを使用します。  

get_case_fields

利用可能なテスト ケースのカスタム フィールドのリストを返します。

GET index.php?/api/v2/get_case_fields

[
    {
        "configs": [
            {
                "context": {
                    "is_global": true,
                    "project_ids": null
                },
                "id": "..",
                "options": {
                    "default_value": "",
                    "format": "markdown",
                    "is_required": false,
                    "rows": "5"
                }
            }
        ],
        "description": "The preconditions of this test case. ..",
        "display_order": 1,
        "id": 1,
        "label": "Preconditions",
        "name": "preconds",
        "system_name": "custom_preconds",
        "type_id": 3
    }, 
    ..
]

POST index.php?/api/v2/add_case_field

新しいカスタム フィールドを作成するときは、 “custom_” 接頭辞は自動的に追加されるため、接頭辞のない名前だけを指定します。例えば、 “my_int” と指定すると、接頭辞が付加されて “custom_my_int” となります。

configs を持つカスタム フィールドには ‘context’ および ‘options’ デフォルト キーが必要です。

"configs": [
    {
        "context":{"is_global": true, "project_ids": []},
        "options":{"is_required": false, "default_value": "1", "items": "1, First\n2, Second"}
    }
]

カスタム フィールドを特定のプロジェクトに適用するには、context を変更します。

"context": {"is_global": false, "project_ids": [5, 10]}

一部のカスタム フィールドタイプには異なるオプションがあります。“is_required” (ブール値) はすべてのフィールドに共通です。Multiselect、Milestone、Date 以外の型には、“default_value” を設定するオプションがあります。

Dropdown と Text には特別なオプションがあります。Dropdown 固有のオプションは items です。

"items": "1, First\n2, Second"

Text の場合は、format と rows を使用します。

"format": "plain", "rows": "5"

“format” は、“plain” または “markdown” のどちらかの値を選択します。“rows” オプションは、ユーザーがフォームをロードしたときのフィールドの初期サイズを指定します。有効な値は、 “3”、“4”、…、 “10” などの値、または “” (空の文字列) です。

"options": {
    "is_required": false,
    "default_value": "The default text.",
    "format": "markdown",
    "rows": "3"
}

リクエストの例

{
    "type": "Multiselect",
    "name": "my_multiselect",
    "label": "My Multiselect",
    "description": "my custom Multiselect description",
    "configs": [
        {
            "context": {
                "is_global": true,
                "project_ids": ""
            },
            "options": {
                "is_required": false,
                "items": "1, One\n2, Two"
            }
        }
    ],
    "include_all": true
}

レスポンスの内容

成功した場合、このメソッドは新しいカスタム フィールドを返します。

{
    "id":33,
    "name":"my_multiselect",
    "system_name":"custom_my_multiselect",
    "entity_id":1,
    "label":"My Multiselect",
    "description":"my custom Multiselect description",
    "type_id":12,
    "location_id":2,
    "display_order":7,
    "configs":"[{\"context\":{\"is_global\":true,\"project_ids\":\"\"},\"options\":{\"is_required\":false,\"items\":\"1, One\\n2, Two\"},\"id\":\"9f105ba2-1ed0-45e0-b459-18d890bad86e\"}]",
    "is_multi":1,
    "is_active":1,
    "status_id":1,
    "is_system":0,
    "include_all":1,
    "template_ids": []
}

レスポンス コード