Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
DevOps Components

Submit DevOps Components

Update / insert DevOps Component data.

Components are identified by their ID, and existing Component data for the same ID will be replaced if it exists and the updateSequenceNumber 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. The getComponentById operation can be used to confirm that data has been stored successfully (if needed).

In the case of multiple Components being submitted in one request, each is validated individually prior to submission. Details of which Components failed submission (if any) are available in the response object.

A maximum of 1000 components can be submitted in one request.

Only Connect apps that define the jiraDevOpsComponentProvider module can access this resource. This resource requires the 'WRITE' scope for Connect apps.

post/rest/devopscomponents/1.0/bulk

Request body

propertiesobject

Properties assigned to incidents/components/review data that can then be used for delete / query operations.

Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.

Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.

Example request

{
  "properties": {
    "accountId": "account-234",
    "projectId": "project-123"
  },
  "devopsComponents": [
    {
      "schemaVersion": "1.0",
      "id": "111-222-333",
      "updateSequenceNumber": 1523494301448,
      "name": "Galactus",
      "providerName": "Marvel",
      "url": "https://example.com/project/MS/galactus/summary",
      "avatarUrl": "https://example.com/project/MS/galactus/logo",
      "tier": "Tier 1",
      "componentType": "Service",
      "lastUpdated": "2018-01-20T23:27:25.000Z"
    }
  ],
  "providerMetadata": {
    "product": "Atlassian Operations Platform 2.1.0"
  }
}

Response

Submission accepted. Each submitted Component that is of a valid format will be eventually available in Jira. Details of which Components were submitted and which failed submission (due to data format problems etc.) are available in the response object.

acceptedComponentsstring[]

The IDs of Components that have been accepted for submission.

A Component may be rejected if it was only associated with unknown project keys.

Note that a Component that isn't updated due to it's updateSequenceNumber being out of order is not considered a failed submission.

failedComponentsobject

Details of Components that have not been accepted for submission, usually due to a problem with the request data.

The object (if present) will be keyed by Component ID and include any errors associated with that Component that have prevented it being submitted.

unknownProjectKeysstring[]

Project keys that are not known on this Jira instance (if any).

These may be invalid keys (e.g. UTF is sometimes incorrectly identified as a Jira project key), or they may be for projects that no longer exist.

If a Component has been associated with project keys other than those in this array it will still be stored against those valid keys. If a Component was only associated with project keys deemed to be invalid it won't be persisted.

Example response

{
  "acceptedComponents": [
    "111-222-333",
    "444-555-666"
  ],
  "unknownProjectKeys": [
    "PROJ"
  ]
}