Update Issue

Updates information about issue.

Role

Administrator
Normal User

Method

PATCH

URL

/api/v2/issues/:issueIdOrKey

URL Parameters

Parameter Name Type Description
issueIdOrKey String Issue ID or Issue Key

Form Parameters

Request Header

Content-Type:application/x-www-form-urlencoded
Parameter Name Type Description
summary String Summary
parentIssueId Number Parent Issue ID
description String Description
statusId Number Status ID
resolutionId Number Resolution ID
startDate String Start Date
dueDate String Due Date
estimatedHours Number Estimated Hours
actualHours Number Actual Hours
issueTypeId (Required) Number Issue Type ID
categoryId[] Number Category ID
versionId[] Number Version ID
milestoneId[] Number Milestone ID
priorityId (Required) Number Priority ID
assigneeId Number Assignee ID
notifiedUserId[] Number Notified User ID
attachmentId[] Number Attachment file ID(Post Attachment File returns)
comment String Comment

Custom Fields

Parameter Name Type Description
customField_{id} - value
customField_{id}_otherValue - Other text of List

Response Example

Status Line / Response Header

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

Response Body

{
    "id": 1,
    "projectId": 1,
    "issueKey": "BLG-1",
    "keyId": 1,
    "issueType": {
        "id": 2,
        "projectId" :1,
        "name": "Task",
        "color": "#7ea800",
        "displayOrder": 0
    },
    "summary": "first issue",
    "description": "",
    "resolutions": null,
    "priority": {
        "id": 3,
        "name": "Normal"
    },
    "status": {
        "id": 1,
        "name": Open"
    },
    "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": [],
    "stars": [
        {
            "id": 10,
            "comment": null,
            "url": "https://xx.backlogtool.com/view/BLG-1",
            "title": "[BLG-1] first issue | Show issue - Backlog",
            "presenter": {
                "id": 2,
                "userId": "eguchi",
                "name": "eguchi",
                "roleType": 2,
                "lang": "ja",
                "mailAddress": "eguchi@nulab.example"
            },
            "created":"2013-07-08T10:24:28Z"
        },
        ...
    ]
}