Cloud

Jira Software Cloud / Reference / REST API

Development Information

APIs related to integrating development information (commits, branches and pull requests) with Jira. These APIs are available to Atlassian Connect apps and on-premise integrations using OAuth. Connect apps using these APIs must have the Development Tool module in the app descriptor, see https://developer.atlassian.com/cloud/jira/software/modules/development-tool/. For more details on integrating Jira Software Cloud with on-premises tools using OAuth 2.0 credentials, see https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/.

Operations

POST/rest/devinfo/0.10/bulk GET/rest/devinfo/0.10/repository/{repositoryId}DEL/rest/devinfo/0.10/repository/{repositoryId}DEL/rest/devinfo/0.10/bulkByProperties GET/rest/devinfo/0.10/existsByProperties DEL/rest/devinfo/0.10/repository/{repositoryId}/{entityType}/{entityId}

POST

Store development information

Stores development information provided in the request to make it available when viewing issues in Jira. Existing repository and entity data for the same ID will be replaced if the updateSequenceId of existing data is less than the incoming data. Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: WRITE

Request

Header parameters

Authorization

string

Required

Request bodyapplication/json

Request object, which contains development information

repositories

array<Repository>

Required

preventTransitions

boolean

operationType

string

properties

object

providerMetadata

ProviderMetadata

Responses

Submission accepted. Each submitted repository and entity that is of a valid format will be eventually available in Jira.

application/json

StoreDevinfoResult

The result of a successful store development information request

POST/rest/devinfo/0.10/bulk

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://your-domain.atlassian.net/rest/devinfo/0.10/bulk' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "repositories": [
    {
      "name": "atlassian-connect-jira-example",
      "description": "The repository which stores code of the Atlassian Connect Add-on Devinfo application.",
      "forkOf": "56c7c750-cee2-48e2-b920-d7706dfd11f7",
      "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example",
      "commits": [
        {
          "id": "a7727ee6350c33cdf90826dc21abaa26a5704370",
          "issueKeys": [
            "<string>"
          ],
          "updateSequenceId": 1523494301248,
          "hash": "<string>",
          "flags": [
            "MERGE_COMMIT"
          ],
          "message": "README.md edited online with Bitbucket",
          "author": {
            "name": "Jane Doe",
            "email": "jane_doe@atlassian.com",
            "username": "jdoe",
            "url": "https://atlassian.com/account/jane_doe",
            "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
          },
          "fileCount": 1,
          "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370",
          "files": [
            {
              "path": "/home/user/src/atlassian-connect-jira-example/README.md",
              "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md",
              "changeType": "MODIFIED",
              "linesAdded": 0,
              "linesRemoved": 1
            }
          ],
          "authorTimestamp": "2016-10-31T23:27:25+00:00",
          "displayId": "a7727ee"
        }
      ],
      "branches": [
        {
          "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
          "issueKeys": [
            "<string>"
          ],
          "updateSequenceId": 1523494301248,
          "name": "master",
          "lastCommit": {
            "id": "a7727ee6350c33cdf90826dc21abaa26a5704370",
            "issueKeys": [
              "<string>"
            ],
            "updateSequenceId": 1523494301248,
            "hash": "<string>",
            "flags": [
              "MERGE_COMMIT"
            ],
            "message": "README.md edited online with Bitbucket",
            "author": {
              "name": "Jane Doe",
              "email": "jane_doe@atlassian.com",
              "username": "jdoe",
              "url": "https://atlassian.com/account/jane_doe",
              "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
            },
            "fileCount": 1,
            "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370",
            "files": [
              {
                "path": "/home/user/src/atlassian-connect-jira-example/README.md",
                "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md",
                "changeType": "MODIFIED",
                "linesAdded": 0,
                "linesRemoved": 1
              }
            ],
            "authorTimestamp": "2016-10-31T23:27:25+00:00",
            "displayId": "a7727ee"
          },
          "createPullRequestUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/new",
          "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/master"
        }
      ],
      "pullRequests": [
        {
          "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
          "issueKeys": [
            "<string>"
          ],
          "updateSequenceId": 1523494301248,
          "status": "OPEN",
          "title": "Pull request 2, fixing all the issues caused by pull request #1",
          "author": {
            "name": "Jane Doe",
            "email": "jane_doe@atlassian.com",
            "username": "jdoe",
            "url": "https://atlassian.com/account/jane_doe",
            "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
          },
          "commentCount": 42,
          "sourceBranch": "ISSUE-1-feature-branch",
          "sourceBranchUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/ISSUE-1-feature-branch",
          "lastUpdate": "2016-10-31T23:27:25+00:00",
          "destinationBranch": "master",
          "destinationBranchUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/master",
          "reviewers": [
            {
              "name": "Jane Doe",
              "approvalStatus": "APPROVED",
              "url": "https://atlassian.com/account/jane_doe",
              "avatar": "https://atlassian.com/account/jane_doe/avatar/32",
              "email": "jane_doe@example.com",
              "accountId": "655363:e4ca5e2d-a901-40e3-877e-bf5d22c0f130"
            }
          ],
          "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/2",
          "displayId": "Pull request 2"
        }
      ],
      "avatar": "http://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/avatar/32",
      "avatarDescription": "Avatar description",
      "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
      "updateSequenceId": 1523494301248
    }
  ],
  "preventTransitions": true,
  "operationType": "NORMAL",
  "properties": {},
  "providerMetadata": {
    "product": "Bitbucket Server 6.7.2"
  }
}'

202Response

{
  "acceptedDevinfoEntities": {},
  "failedDevinfoEntities": {},
  "unknownIssueKeys": [
    "<string>"
  ]
}

GET

Get repository

For the specified repository ID, retrieves the repository and the most recent 400 development information entities. The result will be what is currently stored, ignoring any pending updates or deletes.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: READ

Request

Path parameters

repositoryId

string

Required

Header parameters

Authorization

string

Required

Responses

The repository data currently stored for the given ID.

application/json

Repository

Represents a repository, containing development information such as commits, pull requests, and branches.

GET/rest/devinfo/0.10/repository/{repositoryId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/devinfo/0.10/repository/{repositoryId}' \
  --header 'Accept: application/json'

200Response

{
  "name": "atlassian-connect-jira-example",
  "description": "The repository which stores code of the Atlassian Connect Add-on Devinfo application.",
  "forkOf": "56c7c750-cee2-48e2-b920-d7706dfd11f7",
  "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example",
  "commits": [
    {
      "id": "a7727ee6350c33cdf90826dc21abaa26a5704370",
      "issueKeys": [
        "<string>"
      ],
      "updateSequenceId": 1523494301248,
      "hash": "<string>",
      "flags": [
        "MERGE_COMMIT"
      ],
      "message": "README.md edited online with Bitbucket",
      "author": {
        "name": "Jane Doe",
        "email": "jane_doe@atlassian.com",
        "username": "jdoe",
        "url": "https://atlassian.com/account/jane_doe",
        "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
      },
      "fileCount": 1,
      "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370",
      "files": [
        {
          "path": "/home/user/src/atlassian-connect-jira-example/README.md",
          "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md",
          "changeType": "MODIFIED",
          "linesAdded": 0,
          "linesRemoved": 1
        }
      ],
      "authorTimestamp": "2016-10-31T23:27:25+00:00",
      "displayId": "a7727ee"
    }
  ],
  "branches": [
    {
      "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
      "issueKeys": [
        "<string>"
      ],
      "updateSequenceId": 1523494301248,
      "name": "master",
      "lastCommit": {
        "id": "a7727ee6350c33cdf90826dc21abaa26a5704370",
        "issueKeys": [
          "<string>"
        ],
        "updateSequenceId": 1523494301248,
        "hash": "<string>",
        "flags": [
          "MERGE_COMMIT"
        ],
        "message": "README.md edited online with Bitbucket",
        "author": {
          "name": "Jane Doe",
          "email": "jane_doe@atlassian.com",
          "username": "jdoe",
          "url": "https://atlassian.com/account/jane_doe",
          "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
        },
        "fileCount": 1,
        "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370",
        "files": [
          {
            "path": "/home/user/src/atlassian-connect-jira-example/README.md",
            "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md",
            "changeType": "MODIFIED",
            "linesAdded": 0,
            "linesRemoved": 1
          }
        ],
        "authorTimestamp": "2016-10-31T23:27:25+00:00",
        "displayId": "a7727ee"
      },
      "createPullRequestUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/new",
      "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/master"
    }
  ],
  "pullRequests": [
    {
      "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
      "issueKeys": [
        "<string>"
      ],
      "updateSequenceId": 1523494301248,
      "status": "OPEN",
      "title": "Pull request 2, fixing all the issues caused by pull request #1",
      "author": {
        "name": "Jane Doe",
        "email": "jane_doe@atlassian.com",
        "username": "jdoe",
        "url": "https://atlassian.com/account/jane_doe",
        "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
      },
      "commentCount": 42,
      "sourceBranch": "ISSUE-1-feature-branch",
      "sourceBranchUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/ISSUE-1-feature-branch",
      "lastUpdate": "2016-10-31T23:27:25+00:00",
      "destinationBranch": "master",
      "destinationBranchUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/master",
      "reviewers": [
        {
          "name": "Jane Doe",
          "approvalStatus": "APPROVED",
          "url": "https://atlassian.com/account/jane_doe",
          "avatar": "https://atlassian.com/account/jane_doe/avatar/32",
          "email": "jane_doe@example.com",
          "accountId": "655363:e4ca5e2d-a901-40e3-877e-bf5d22c0f130"
        }
      ],
      "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/2",
      "displayId": "Pull request 2"
    }
  ],
  "avatar": "http://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/avatar/32",
  "avatarDescription": "Avatar description",
  "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
  "updateSequenceId": 1523494301248
}

DEL

Delete repository

Deletes the repository data stored by the given ID and all related development information entities. Deletion is performed asynchronously.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: DELETE

Request

Path parameters

repositoryId

string

Required

Query parameters

_updateSequenceId

integer

Header parameters

Authorization

string

Required

Responses

Delete request has been accepted. Data will eventually be removed from Jira if it exists.

DEL/rest/devinfo/0.10/repository/{repositoryId}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/rest/devinfo/0.10/repository/{repositoryId}'

DEL

Delete development information by properties

Deletes development information entities which have all the provided properties. Repositories which have properties that match ALL of the properties (i.e. treated as an AND), and all their related development information (such as commits, branches and pull requests), will be deleted. For example if request is DELETE bulk?accountId=123&projectId=ABC entities which have properties accountId=123 and projectId=ABC will be deleted. Optional param _updateSequenceId is no longer supported. Deletion is performed asynchronously: specified entities will eventually be removed from Jira.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: DELETE

Request

Query parameters

_updateSequenceId

integer

Header parameters

Authorization

string

Required

Responses

Delete accepted. Data will eventually be removed from Jira.

DEL/rest/devinfo/0.10/bulkByProperties

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/rest/devinfo/0.10/bulkByProperties'

GET

Check if data exists for the supplied properties

Checks if repositories which have all the provided properties exists. For example, if request is GET existsByProperties?accountId=123&projectId=ABC then result will be positive only if there is at least one repository with both properties accountId=123 and projectId=ABC. Special property _updateSequenceId can be used to filter all entities with updateSequenceId less or equal than the value specified. In addition to the optional _updateSequenceId, one or more query params must be supplied to specify properties to search by.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: READ

Request

Query parameters

_updateSequenceId

integer

Header parameters

Authorization

string

Required

Responses

Returns whether data exists for the specified properties.

application/json

ExistsForPropertiesResponse

Whether there is data for the properties supplied in a query

GET/rest/devinfo/0.10/existsByProperties

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/devinfo/0.10/existsByProperties' \
  --header 'Accept: application/json'

200Response

1
2
3

{
  "hasDataMatchingProperties": true
}

DEL

Delete development information entity

Deletes particular development information entity. Deletion is performed asynchronously.

Data Security Policy: Not exempt from app access rules

Scopes

Connect app scope required: DELETE

Request

Path parameters

repositoryId

string

Required

entityType

string

Required

entityId

string

Required

Query parameters

_updateSequenceId

integer

Header parameters

Authorization

string

Required

Responses

Delete request has been accepted. Data will eventually be removed from Jira if it exists.

DEL/rest/devinfo/0.10/repository/{repositoryId}/{entityType}/{entityId}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/rest/devinfo/0.10/repository/{repositoryId}/{entityType}/{entityId}'