Incident Controller

In this article you will learn how to retrieve and create Incidents using the REST API. In ISM, incidents are caused due to interruptions or a reduction in the quality of the service that is caused by:

• Known or existing issue
• Result of a failure
• Error in the IT object or device

Get Method - Retrieve Incident

While retrieving a record such as incident, from a server, you can learn how APIs use HTTP methods and Response codes to differentiate operations and results. The following example describes how you can retrieve the existing incidents record.:

1. Click GET or Expand Operations to retrieve information.
   
   
2. Specify the following details in the Parameters section.:
     - ISM application URL
     - User authtoken
     - Slice token
     - Web service user name and password
3. Click Try it out. You will get the response as follows.

Response

After the GET request is executed, a response is received in the following format as specified below.

POST Method- Incident

You can use a POST method to create a new resource such as incident, request, and so on. The following example describes how you can create a new incident.

1. Click POST to create information.
   
   
2. Specify the following details in the Parameters section.:
     - ISM application URL
     - User authtoken
     - Slice token
     - Web service user name and password
3. Click the Example Value text box. The operations displayed in the text box will be copied to the Incident text box.
4. Click Try it out. You will get the response as follows.

Valid Ticket Attributes

The following information is displayed in the Example Value box. This is applicable to all the ticket types.

Sample for Assigning a Ticket Using REST

{

"TicketIdentifier":"200-2",

"AssignedContactUserName":"AnalystUsername",

"AssignedGroup":"Administration"

}

Sample for Adding a worklog and send email to the recipients (testuser@acme.com and test@acme.com) using REST

{

"TicketIdentifier":"200-3","communicationSendCC":"test@acme.com",

"communicationSendTo":"testuser@acme.com",

"ClientViewable":"1",

"sendMail":"1",

"WorklogTypeCode":"1",

"Text":"The
ticket has been fixed, validate and revert"

}

Response

After the POST request is executed, a response is received in the following format as specified below.

Sample 

GET Method - Incident/{id}

You can use this method to retrieve a specific incident details by specifying the ID. The following example describes how you can get details of a specific incident.:

1. Click GET to retrieve a specific incident information.
   
   
2. Specify the following details in the Parameters section.:
     - ISM application URL
     - User authtoken
     - Slice token
     - Web service user name and password
     - Specify the incident ID for which you want to retrieve information.
3. Click Try it out. You will get the response as follows.
   
   

Now, you can validate the response code using the Status code/Response Code section in this article.