Incident API

AVAILABLE IN

South Africa

Download

Download Postman collection Download Swagger

Available endpoints

POST incident

Description

Create a new ticket by specifying the 'originIncidentNumber'.

Header parameters

Content-Type application/json

FormData parameters

targetSystem string required
System receiving the request
originSystem string required
System originating the request
transactionId string required
Transaction identifier used by client
callerId string required
User from calling system
originIncidentNumber string required
Origin ticket identifier, this is the id of the ticket at the originating system
shortDescription string required
Brief description about the ticket
detailedDescription string
More detailed description of the ticket
impact string
Level of impact
urgency string
Level of urgency
attachmentFilename string
Name of file being attached
attachmentData string
Attachment data encoded in base64
201Created
targetIncidentNumber string
Target ticket identifier, this is the id of the ticket at the target system
statusCode string
Status code from target system to indicate transaction status
statusMessage string
Status response description
originTransactionId string
Transaction identifier generated by system originating the request
targetTransactionId string
Transaction identifier generated by target
{
    "targetIncidentNumber": "string",
    "statusCode": "string",
    "statusMessage": "string",
    "originTransactionId": "string",
    "targetTransactionId": "string"
}
401Unauthorized
404Not Found
407Proxy Authentication Required
500Internal Server Error
PATCH incident

Description

This call is used to update a ticket that already exists by using the 'targetIncidentNumber'.

Header parameters

Content-Type application/json

FormData parameters

transactionId string required
Transaction identifier used by client
originSystem string required
System originating the request
targetSystem string required
System receiving the request
targetIncidentNumber string required
Incident number at the target system
shortDescription string
Brief description about the ticket
detailedDescription string
More detailed description of the ticket
impact string
Level of impact
urgency string
Level of urgency
attachmentFilename string
Name of file being attached
attachmentData string
Attachment data encoded in base64
state string
Only applicable for values 2,3,6,7,8. Value 1 is set when an incident is created. Value 2 can only be set if the ticket 'assignedTo' field was prevously set
assignedTo string
Who the incident is assigned to
closeCode string
Applicable when setting 'state' to 6. This value is used to indicate the code for resolution.
closeNotes string
Custom notes for closing ticket.
comments string
Comments to incident
workNotes string
Work notes to incident
subcategory string
Incident category
200OK
targetIncidentNumber string
Target ticket identifier, this is the id of the ticket at the target system
statusCode string
Status code from target system to indicate transaction status
statusMessage string
Status response description
originTransactionId string
Transaction identifier generated by system originating the request
targetTransactionId string
Transaction identifier generated by target
{
    "targetIncidentNumber": "string",
    "statusCode": "string",
    "statusMessage": "string",
    "originTransactionId": "string",
    "targetTransactionId": "string"
}
401Unauthorized
404Not Found
407Proxy Authentication Required
500Internal Server Error