Contents

Add Issue

Adds new issue.

Role

Administrator
Normal User
Reporter
Guest Reporter

Method

POST

URL

/api/v2/issues

Form parameters

Content-Type:application/x-www-form-urlencoded
Parameter NameTypeDescription
projectId (Required)NumberProject ID
summary (Required)StringSummary
parentIssueIdNumberParent Issue ID
descriptionStringDescription
startDateStringStart Date (yyyy-MM-dd)
dueDateStringDue Date (yyyy-MM-dd)
estimatedHoursNumberEstimated Hours
actualHoursNumberActual Hours
issueTypeId (Required)NumberIssue Type ID
categoryId[]
(Multiple)
NumberCategory ID
versionId[]
(Multiple)
NumberVersion ID
milestoneId[]
(Multiple)
NumberMilestone ID
priorityId (Required)NumberPriority ID
assigneeIdNumberAssignee ID
notifiedUserId[]
(Multiple)
NumberNotified User ID
attachmentId[]
(Multiple)
NumberAttachment file ID(Post Attachment File returns)

Custom Fields

Parameter NameTypeDescription
customField_{id}-value
customField_{id}_otherValue-Other text of List

Response example

Status Line / Response Header

HTTP/1.1 201 CREATED
Content-Type:application/json;charset=utf-8
Location:https://xx.backlogtool.com/view/BLG-5742

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": "",
    "resolution": null,
    "priority": {
        "id": 3,
        "name": "Normal"
    },
    "status": {
        "id": 1,
        "projectId": 1,
        "name": "Open",
        "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": [
        {
            "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",
        "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": [
        {
            "id": 1,
            "name": "IMGP0088.JPG",
            "size": 85079
        },
        // ...
    ],
    "sharedFiles": [],
    "stars": []
}