Contents

カスタム属性一覧の取得

GET /api/v2/projects/:projectIdOrKey/customFields

参加しているプロジェクトのカスタム属性一覧を取得します。

実行可能な権限

すべての権限

URL パラメーター

パラメーター名内容
projectIdOrKeystringプロジェクトのID または プロジェクトキー
自分が参加しているプロジェクトの一覧はプロジェクト一覧の取得から取得できます。

リクエストの例

curl --request GET \
--url "https://{{YOUR-DOMAIN}}/api/v2/projects/{{PROJECT_ID_OR_KEY}}/customFields?apiKey=$API_KEY"

{{YOUR-DOMAIN}}には、対象のスペースのドメインを記入してください。ドメインは、以下のいずれかです。スペースIDが不明の場合は、スペースIDとは?を参照してください。

  • https://[スペースID].backlog.com
  • https://[スペースID].backlog.jp
  • https://[スペースID].backlogtool.com

{{PROJECT_ID_OR_KEY}} には、プロジェクトのIDまたはプロジェクトキーを記入してください。

レスポンス例

ステータスライン / レスポンスヘッダ

HTTP/1.1 200 OK
Content-Type:application/json;charset=utf-8

レスポンスボディ

[
    {
        "id": 1,
        "projectId": 5,
        "typeId": 6,
        "name": "custom",
        "description": "",
        "required": false,
        "applicableIssueTypes": [],
        "allowAddItem": false,
        "items": [
            {
                "id": 1,
                "name": "Windows 8",
                "displayOrder": 0
            },
            // ...
        ]
    },
    {
        "id": 2,
        "typeId": 1,
        "name": "バグ専用属性",
        "description": "",
        "required": false,
        "applicableIssueTypes": [1]
    },
    // ...
]

エラーレスポンス

エラーレスポンスを参照してください。

制限事項

レート制限を参照してください