Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Operations

Submit Incident or Review data

Update / insert Incident or Review data.

Incidents and reviews are identified by their ID, and existing Incident and Review 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 getIncidentById or getReviewById operation can be used to confirm that data has been stored successfully (if needed).

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

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

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

post/rest/operations/1.0/bulk

Request body

OR

Example request

{
  "incidents": [
    {
      "schemaVersion": "1.0",
      "id": "111-222-333",
      "updateSequenceNumber": 1523494301448,
      "affectedComponents": [
        "111-222-333",
        "444-555-666"
      ],
      "summary": "Unable to log into VPN",
      "url": "https://example.com/project/ITHELPDESK-9/summary",
      "createdDate": "2018-01-20T23:27:25.000Z",
      "lastUpdated": "2018-01-20T23:27:25.000Z",
      "severity": {
        "level": "P1"
      },
      "status": "open",
      "associations": [
        {
          "associationType": "issueIdOrKeys",
          "values": [
            "ITSM-123"
          ]
        }
      ]
    }
  ],
  "properties": {
    "accountId": "account-234",
    "projectId": "project-123"
  },
  "providerMetadata": {
    "product": "Atlassian Operations Platform 2.1.0"
  }
}

Response

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

Details of which Incidents were submitted and which failed submission (due to data format problems etc.) are available in the response object.

acceptedIncidentsstring[]

The IDs of Incidents that have been accepted for submission.

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

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

failedIncidentsobject

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

The object (if present) will be keyed by Incident ID and include any errors associated with that Incident 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 Incident has been associated with project keys other than those in this array it will still be stored against those valid keys. If a Incident was only associated with project keys deemed to be invalid it won't be persisted.

Example response

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