The API returns a JSON array with incident details.
A sample response is as follows:
[
{
"summary": "Monitoring for HMC",
"severity": "1",
"description": "Team is monitoring for HMC environment",
"action": "CREATE",
"incidentId": 2357666,
"creationDate": "2022-03-14T11:59:55 UTC",
"status": "WIP",
"externalId": null, // External ID is not present for a newly created incident
"primaryCI": “Test”,
"worklog": null
},
{
"summary": "Critical System Update",
"severity": "2",
"description": "Applying critical updates to the system",
"action": "UPDATE",
"incidentId": 2965355,
"creationDate": "2023-11-21T07:21:10 UTC",
"status": "WIP",
"externalId": "1234567890",
"primaryCI": "prte_prt1",
"worklog": [
{
"wlTime": "2023-11-21T07:21:10 UTC",
"wlSource": "Manual",
"wlSummary": null
},
{
"wlTime": "2023-11-09T02:53:36 UTC",
"wlSource": "System",
"wlSummary": "Incident Ticket 2965666 - Severity 2 Notification for ACME EXPRESS - prte_prt1"
}
]
}
]
Where the values represent:
summary: The summary or title of the incident.
severity: The severity level of the incident.
description: A detailed description of the incident.
action: The action performed for the incident. The possible values are:
CREATE
UPDATE
incidentId: A unique identifier for the incident.
creationDate: The date and time when the incident was created.
status: Current status of the incident. The possible values are:
Draft
Pending Assignment
WIP
On Hold
Cancelled
Resolved
Closed
externalId: An external identifier for the incident.
primaryCI: The primary Configuration Item for the incident.
worklog: Worklog details for the incident, including time, source, and summary.