Interface Incident

Incident

Data related to a specific incident in a specific container that the incident is present in. Must specify at least one association to a component.

interface Incident {
    affectedComponents: string[];
    associations?: ({
        associationType?: "issueIdOrKeys" | "serviceIdOrKeys" | "ati:cloud:compass:event-source";
        values?: string[];
    } & {
        [key: string]: unknown;
    })[];
    createdDate: string;
    description: string;
    id: string;
    lastUpdated: string;
    schemaVersion: "1.0";
    severity?: unknown;
    status: "open" | "unknown" | "resolved";
    summary: string;
    updateSequenceNumber: number;
    url: string;
}

Properties

affectedComponents associations? createdDate description id lastUpdated schemaVersion severity? status summary updateSequenceNumber url

Properties

affectedComponents

affectedComponents: string[]

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

Example

[
  "111-222-333",
  "444-555-666"
]

Optionalassociations

associations?: ({
    associationType?: "issueIdOrKeys" | "serviceIdOrKeys" | "ati:cloud:compass:event-source";
    values?: string[];
} & {
    [key: string]: unknown;
})[]

The IDs of the Jira issues related to this Incident. Must be unique for a given Provider.

createdDate

createdDate: string

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

Expected format is an RFC3339 formatted string.

Example

2018-01-20T23:27:25.000Z

description

description: string

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

Example

null

id

id: string

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

Example

111-222-333

lastUpdated

lastUpdated: string

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

Expected format is an RFC3339 formatted string.

Example

2018-01-20T23:27:25.000Z

schemaVersion

schemaVersion

The IncidentData schema version used for this incident data.

Placeholder to support potential schema changes in the future.

Example

1

Optionalseverity

severity?: unknown

IncidentSeverity

Severity information for a single Incident.

This is the severity information that will be presented to the user on e.g. the Jira Incidents screen.

status

status: "open" | "unknown" | "resolved"

IncidentStatus

The current status of the Incident.

Example

open

summary

summary: string

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

If not provided, will use the ID for display.

Example

Unable to log into VPN

updateSequenceNumber

updateSequenceNumber: number

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.

Example

1523494301448

url

url: string

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).

Example

https://example.com/project/ITHELPDESK-9/summary

Settings

Member Visibility

On This Page

Properties