Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Operations

Get a Incident by ID

Retrieve the currently stored Incident data for the given ID.

The result will be what is currently stored, ignoring any pending updates or deletes.

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

get/rest/operations/1.0/incidents/{incidentId}

Path parameters

incidentIdstring required

The ID of the Incident to fetch.

Response

The Incident data currently stored for the given ID.

schemaVersion'1.0' required

The IncidentData schema version used for this incident data.

Placeholder to support potential schema changes in the future.

idstring required

The identifier for the Incident. Must be unique for a given Provider.

updateSequenceNumberinteger required

An ID used to apply an ordering to updates for this Incident in the case of out-of-order receipt of update requests.

This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each Incident and increment that on each update to Jira).

Updates for a Incident that are received with an updateSqeuenceId lower than what is currently stored will be ignored.

affectedComponentsstring[] required

The IDs of the Components impacted by this Incident. Must be unique for a given Provider.

summarystring required

The human-readable summary for the Incident. Will be shown in the UI.

If not provided, will use the ID for display.

descriptionstring required

A description of the issue in Markdown format. Will be shown in the UI and used when creating Jira Issues.

urlstring uri required

A URL users can use to link to a summary view of this incident, if appropriate.

This could be any location that makes sense in the Provider system (e.g. if the summary information comes from a specific project, it might make sense to link the user to the incident in that project).

createdDatestring date-time required

The timestamp to present to the user that shows when the Incident was raised.

Expected format is an RFC3339 formatted string.

lastUpdatedstring date-time required

The last-updated timestamp to present to the user the last time the Incident was updated.

Expected format is an RFC3339 formatted string.

status'open' | 'resolved' | 'unknown' required

The current status of the Incident.

Example response

{
  "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"
      ]
    }
  ]
}