Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Development Information

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.

post/rest/devinfo/0.10/bulk

Headers

Authorizationstring required

All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.

Request body

preventTransitionsboolean

Flag to prevent automatic issue transitions and smart commits being fired, default is false.

operationType'NORMAL' | 'BACKFILL'

Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received during normal operation (e.g. a user pushing a branch). "BACKFILL" - Data received while backfilling existing data (e.g. indexing a newly connected account). Default is "NORMAL". Please note that "BACKFILL" operations have a much higher rate-limiting threshold but are also processed slower in comparison to "NORMAL" operations.

propertiesobject

Arbitrary properties to tag the submitted repositories with. These properties can be used for delete operations to e.g. clean up all development information associated with an account in the event that the account is removed from the provider system. Note that these properties will never be returned with repository or entity data. They are not intended for use as metadata to associate with a repository. Maximum length of each key or value is 255 characters. Maximum allowed number of properties key/value pairs is 5. Properties keys cannot start with '_' character. Properties keys cannot contain ':' character.

Example request

{
  "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",
          "associations": [
            {
              "associationType": "issueIdOrKeys",
              "values": [
                "ABC-123",
                "ABC-456"
              ]
            }
          ],
          "updateSequenceId": 1523494301248,
          "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",
              "linesRemoved": 1
            }
          ],
          "authorTimestamp": "2016-10-31T23:27:25+00:00",
          "displayId": "a7727ee"
        }
      ],
      "branches": [
        {
          "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
          "associations": [
            {
              "associationType": "issueIdOrKeys",
              "values": [
                "ABC-123",
                "ABC-456"
              ]
            }
          ],
          "updateSequenceId": 1523494301248,
          "name": "master",
          "lastCommit": {
            "id": "a7727ee6350c33cdf90826dc21abaa26a5704370",
            "updateSequenceId": 1523494301248,
            "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",
                "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",
          "associations": [
            {
              "associationType": "issueIdOrKeys",
              "values": [
                "ABC-123",
                "ABC-456"
              ]
            }
          ],
          "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
    }
  ],
  "operationType": "NORMAL",
  "providerMetadata": {
    "product": "Bitbucket Server 6.7.2"
  }
}

Response

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

acceptedDevinfoEntitiesobject

The IDs of devinfo entities that have been accepted for submission grouped by their repository IDs. Note that a devinfo entity that isn't updated due to it's updateSequenceId being out of order is not considered a failed submission.

failedDevinfoEntitiesobject

IDs of devinfo entities that have not been accepted for submission and caused error descriptions, usually due to a problem with the request data. The entities (if present) will be grouped by their repository id and type. Entity IDs are listed with errors associated with that devinfo entity that have prevented it being submitted.

unknownIssueKeysstring[]

Issue keys that are not known on this Jira instance (if any). These may be invalid keys (e.g. UTF-8 is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist. If a devinfo entity has been associated with issue keys other than those in this array it will still be stored against those valid keys.

Example response

{
  "unknownAssociations": [
    {
      "associationType": "issueIdOrKeys",
      "values": [
        "ABC-123",
        "ABC-456"
      ]
    }
  ]
}