Contents

関連課題の追加

POST /api/v2/issues/:issueIdOrKey/relatedIssues

課題に関連課題を追加します。
targetIssueIdには、実行者が参照できる課題のみ指定できます。
1つの課題に追加できる関連課題は50件までです。
すでに関連付けられている課題や課題自身を指定した場合はエラーにならず、現在の課題情報がそのまま返されます。

実行可能な権限

管理者
一般ユーザー
レポーター
ゲストレポーター

URL パラメーター

パラメーター名内容
issueIdOrKeystring以下のいずれかを指定します。
  • 課題のID
  • 課題キー
課題のIDと課題キーは課題一覧の取得から取得できます。

リクエストパラメーター

Content-Type:application/x-www-form-urlencoded
パラメーター名内容
targetIssueId(必須)int関連付ける課題のID。
課題のIDは課題情報の取得から取得できます。

リクエストの例

curl --request POST \
--url "https://{{YOUR-DOMAIN}}/api/v2/issues/SAMPLE-1/relatedIssues?apiKey=$API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data targetIssueId=1

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

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

レスポンス例

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

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

レスポンスボディ

{
    "id": 2,
    "projectId": 1,
    "issueKey": "BLG-2",
    "keyId": 2,
    "issueType": {
        "id": 2,
        "projectId": 1,
        "name": "タスク",
        "color": "#7ea800",
        "displayOrder": 0
    },
    "summary": "second issue",
    "description": "",
    "resolution": null,
    "priority": {
        "id": 3,
        "name": "中"
    },
    "status": {
        "id": 1,
        "projectId": 1,
        "name": "未対応",
        "color": "#ed8077",
        "displayOrder": 1000
    },
    "assignee": {
        "id": 2,
        "userId": "eguchi",
        "name": "eguchi",
        "roleType": 2,
        "lang": null,
        "nulabAccount": {
            "nulabId": "tSaVeJfRxLURSAkgfbNAfCbM7PqddYLJ3nG3BELjx6eSTbu8LD",
            "name": "eguchi",
            "uniqueId": "eguchi"
        },
        "mailAddress": "eguchi@nulab.example",
        "lastLoginTime": "2022-09-01T06:35:39Z"
    },
    "category": [],
    "versions": [],
    "milestone": [],
    "startDate": null,
    "dueDate": null,
    "estimatedHours": null,
    "actualHours": null,
    "parentIssueId": null,
    "createdUser": {
        "id": 1,
        "userId": "admin",
        "name": "admin",
        "roleType": 1,
        "lang": "ja",
        "nulabAccount": {
            "nulabId": "Prm9ZD9DQD5snNWcSYSwZiQoA9WFBUEa2ySznrSnSQRhdC2X8G",
            "name": "admin",
            "uniqueId": "admin"
        },
        "mailAddress": "eguchi@nulab.example",
        "lastLoginTime": "2022-09-01T06:35:39Z"
    },
    "created": "2012-07-23T06:10:15Z",
    "updatedUser": {
        "id": 1,
        "userId": "admin",
        "name": "admin",
        "roleType": 1,
        "lang": "ja",
        "nulabAccount": {
            "nulabId": "Prm9ZD9DQD5snNWcSYSwZiQoA9WFBUEa2ySznrSnSQRhdC2X8G",
            "name": "admin",
            "uniqueId": "admin"
        },
        "mailAddress": "eguchi@nulab.example",
        "lastLoginTime": "2022-09-01T06:35:39Z"
    },
    "updated": "2012-07-23T06:10:15Z",
    "customFields": [],
    "attachments": [],
    "sharedFiles": [],
    "externalFileLinks": [],
    "stars": [],
    "type": "RELATES"
}

エラーレスポンス

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

制限事項

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

bラボ(Backlog Community Lab)のロゴ

bラボ(Backlog Community Lab)は、Backlogのユーザー向けオンラインコミュニティです。
Backlogの活用ノウハウ、他社事例をご用意。ほかのユーザーとBacklogの情報交換もできます。