課題一覧の取得

課題の一覧を取得します。

メソッド

GET 

URL

/api/v2/issues 

クエリパラメーター

パラメーター名 内容
projectId[] 数値 プロジェクトのID
issueTypeId[] 数値 種別のID
categoryId[] 数値 カテゴリーのID
versionId[] 数値 発生バージョンのID
milestoneId[] 数値 マイルストーンのID
statusId[] 数値 状態のID
priorityId[] 数値 優先度のID
assigneeId[] 数値 担当者のID
createdUserId[] 数値 登録者のID
resolutionId[] 数値 完了理由のID
parentChild 数値 親子課題の条件
0: すべて
1: 子課題以外
2: 子課題
3: 親課題でも子課題でもない課題
4: 親課題
attachment 真偽値 添付ファイルを含む場合はtrue
sharedFile 真偽値 共有ファイルを含む場合はtrue
sort 文字列 課題一覧のソートに使用する属性名
“issueType”
“category”
“version”
“milestone”
“summary”
“status”
“priority”
“attachment”
“sharedFile”
“created”
“createdUser”
“updated”
“updatedUser”
“assignee”
“startDate”
“dueDate”
“estimatedHours”
“actualHours”
“childIssue”
“customField_${id}”
order 文字列 “asc”または”desc” 指定が無い場合は”desc”
offset 数値
count 数値 取得上限(1-100) 指定が無い場合は20
createdSince 文字列 登録日
createdUntil 文字列 登録日
updatedSince 文字列 更新日
updatedUntil 文字列 更新日
startDateSince 文字列 開始日
startDateUntil 文字列 開始日
dueDateSince 文字列 期限日
dueDateUntil 文字列 期限日
id[] 数値 課題のID
parentIssueId[] 数値 親課題のID
keyword 文字列 検索キーワード

カスタム属性を指定した検索 (テキスト属性)

パラメーター名 内容
customField_${id} 文字列 検索キーワード

カスタム属性を指定した検索 (数値属性)

パラメーター名 内容
customField_${id}_min 数値 最小値
customField_${id}_max 数値 最大値

カスタム属性を指定した検索 (日付属性)

パラメーター名 内容
customField_${id}_min 文字列 最小値
customField_${id}_max 文字列 最大値

カスタム属性を指定した検索 (リスト属性)

パラメーター名 内容
customField_${id}[] 数値 値のID

レスポンス例

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

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

レスポンスボディ

[ 
    { 
        "id": 1, 
        "projectId": 1, 
        "issueKey": "BLG-1", 
        "keyId": 1, 
        "issueType": { 
            "id": 2, 
            "projectId" :1, 
            "name": "タスク", 
            "color": "#7ea800", 
            "displayOrder": 0 
        }, 
        "summary": "first issue", 
        "description": "", 
        "resolutions": null, 
        "priority": { 
            "id": 3, 
            "name": "中" 
        }, 
        "status": { 
            "id": 1, 
            "name": "未対応" 
        }, 
        "assignee": { 
            "id": 2, 
            "name": "eguchi", 
            "roleType" :2, 
            "lang": null, 
            "mailAddress": "eguchi@nulab.example" 
        }, 
        "category": [], 
        "versions": [], 
        "milestone": [ 
            { 
                "id": 30, 
                "projectId": 1, 
                "name": "wait for release", 
                "description": "", 
                "startDate": null, 
                "releaseDueDate": null, 
                "archived": false, 
                "displayOrder": 0 
            } 
        ], 
        "startDate": null, 
        "dueDate": null, 
        "estimatedHours": null, 
        "actualHours": null, 
        "parentIssueId": null, 
        "createdUser": { 
            "id": 1, 
            "userId": "admin", 
            "name": "admin", 
            "roleType": 1, 
            "lang": "ja", 
            "mailAddress": "eguchi@nulab.example" 
        }, 
        "created": "2012-07-23T06:10:15Z", 
        "updatedUser": { 
            "id": 1, 
            "userId": "admin", 
            "name": "admin", 
            "roleType": 1, 
            "lang": "ja", 
            "mailAddress": "eguchi@nulab.example" 
        }, 
        "updated": "2013-02-07T08:09:49Z", 
        "customFields": [], 
        "attachments": [ 
            { 
                "id": 1, 
                "name": "IMGP0088.JPG", 
                "size": 85079 
            }, 
            ... 
        ], 
        "sharedFiles": [ 
            { 
                "id": 454403, 
                "type": "file", 
                "dir": "/ユーザアイコン/", 
                "name": "01_サラリーマン.png", 
                "size": 2735, 
                "createdUser": { 
                    "id": 5686, 
                    "userId": "takada", 
                    "name": "takada", 
                    "roleType":2, 
                    "lang":"ja", 
                    "mailAddress":"takada@nulab.example" 
                }, 
                "created": "2009-02-27T03:26:15Z", 
                "updatedUser": { 
                    "id": 5686, 
                    "userId": "takada", 
                    "name": "takada", 
                    "roleType": 2, 
                    "lang": "ja", 
                    "mailAddress": "takada@nulab.example" 
                }, 
                "updated":"2009-03-03T16:57:47Z" 
            }, 
            ... 
        ], 
        "stars": [ 
            { 
                "id": 10, 
                "comment": null, 
                "url": "https://xx.backlog.jp/view/BLG-1", 
                "title": "[BLG-1] first issue | 課題の表示 - Backlog", 
                "presenter": { 
                    "id": 2, 
                    "userId": "eguchi", 
                    "name": "eguchi", 
                    "roleType": 2, 
                    "lang": "ja", 
                    "mailAddress": "eguchi@nulab.example" 
                }, 
                "created":"2013-07-08T10:24:28Z" 
            }, 
            ... 
        ] 
    } 
]