Add Pull Request

Adds pull requests.

Role

Administrator 
Normal User 

Method

POST 

URL

/api/v2/projects/:projectIdOrKey/git/repositories/:repoIdOrName/pullRequests 

URL parameters

Parameter Name Type Description
projectIdOrKey String Project ID or Project Key
repoIdOrName String Repository ID or Repository name

Form parameters

Content-Type:application/x-www-form-urlencoded 
Parameter Name Type Description
summary (required) String Summary of pull request
description String Description of pull request
base String Branch name of merge base
branch String Name of merging branch
issueId Number Related issue’s ID
assigneeId Number Assignee’s ID of pull request
notifiedUserId[] Number User ID to send notification when pull request is added
attachmentId[] Number ID returned by “Post Attachment File” API

Response example

Status Line / Response Header

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

Response Body

{ 
    "id": 2, 
    "projectId": 3, 
    "repositoryId": 5, 
    "number": 1, 
    "summary": "test", 
    "description": "test data", 
    "base": "master", 
    "branch": "develop", 
    "status": { 
        "id": 1, 
        "name": "Open" 
    }, 
    "assignee": { 
        "id": 5, 
        "userId": "testuser2", 
        "name": "testuser2", 
        "roleType": 1, 
        "lang": null, 
        "mailAddress": "testuser2@nulab.test" 
    }, 
    "issue": { 
        "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 
            } 
        ], 
        "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": "/User icon/", 
                "name": "male clerk 1.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 | Show issue - Backlog", 
                "presenter": { 
                    "id": 2, 
                    "userId": "eguchi", 
                    "name": "eguchi", 
                    "roleType": 2, 
                    "lang": "ja", 
                    "mailAddress": "eguchi@nulab.example" 
                }, 
                "created":"2013-07-08T10:24:28Z" 
            }, 
            ... 
        ] 
    }, 
    "baseCommit": null, 
    "branchCommit": null, 
    "closeAt": null, 
    "mergeAt": null, 
    "createdUser":{ 
        "id": 1, 
        "userId": "admin", 
        "name": "admin", 
        "roleType": 1, 
        "lang": "ja", 
        "mailAddress": "eguchi@nulab.example" 
    }, 
    "created": "2015-04-23T03:04:14Z", 
    "updatedUser": { 
        "id": 1, 
        "userId": "admin", 
        "name": "admin", 
        "roleType": 1, 
        "lang": "ja", 
        "mailAddress": "eguchi@nulab.example" 
    }, 
    "updated":"2015-04-23T03:04:14Z" 
}