Retrieve incident types available in the system.

get /v2/IncidentTypes

Returns an array of incident types which have an Operational status of In service. If this user has the Monitor incidents set to Testing mode privilege, returns all incident types which have an Operational status of In service or Testing in the system.

Query parameters

offset

Integer

int32

This query parameter allows you to set the number of items to be skipped. <br />The default value for this parameter is 0.

Example: 56

limit

Integer

int32

This query parameter allows you to set the number of items to retrieve. Maximum value: 100. <br />The default value for this parameter is 25.

Example: 56

showTriggerable

Boolean

The query parameter that allows the return of disabled incident types if the user is allowed. _Example:_ `?showTriggerable=true;

Example: true

CLIENT REQUEST

          curl -X 'GET'

        -H
        'Accept: application/json'
      
      'http://localhost/v2/IncidentTypes?offset=56&limit=56&showTriggerable=true'

Responses

Success

Body

TotalResultsCountIntegerint32

ResultsArray[none]

RESPONSE

{
  "TotalResultsCount": 3,
  "Results": [
    {
      "Id": "09d073ea-e739-4fbb-8384-2d5a1ffcf3df",
      "Revision": 1234,
      "Name": "Incident Type 1",
      "Description": "Description 1",
      "IsManuallyTriggerable": true,
      "CategoryId": "d89835ab-6ad4-46d8-8e50-37c11a1e50ea",
      "PriorityId": "2264259d-7efb-497c-ac12-f85a872c670e",
      "SubIncidentIds": [],
      "ArgbColor": "#FFFFFFFF",
      "SoundId": "c715d0ac-aa61-41b9-9b6a-f8306fd238dd",
      "IconId": "e1d62161-5e1c-4a55-aabb-98874037b82e",
      "OperationalMode": "Active",
      "VideoMode": 0,
      "IsCollaborative": false,
      "DispathToSupervisorOnly": false
    },
    {
      "Id": "e870ff1c-1a48-4648-bdb5-ea7558ccb162",
      "Revision": 1234,
      "Name": "Incident Type 2",
      "Description": "",
      "IsManuallyTriggerable": true,
      "CategoryId": "a47b3771-ed8f-4967-960f-5fb0ca71d286",
      "PriorityId": "65952488-ed40-45c2-908d-8e70357ad105",
      "SubIncidentIds": [],
      "ArgbColor": "#FFFFFFFF",
      "SoundId": "0da19a1f-5a88-43e1-838c-40fc2e53c89a",
      "IconId": "cb0a2418-5486-4f7f-aeee-2fe9cd133db3",
      "OperationalMode": "Active",
      "VideoMode": 0,
      "IsCollaborative": false,
      "DispathToSupervisorOnly": false
    },
    {
      "Id": "cdb9f73c-1b5c-4ac9-a1a5-28d9f8f3eef5",
      "Revision": 1234,
      "Name": "Incident Type 3",
      "Description": "Description 3",
      "IsManuallyTriggerable": true,
      "CategoryId": "ec855101-ae52-4621-ac78-9bb6ce733d94",
      "PriorityId": "8940f325-3d10-47db-ae8d-138a5b8072ab",
      "SubIncidentIds": [],
      "ArgbColor": "#FFFFFFFF",
      "SoundId": "c55e0383-6dd8-4c0d-b9fa-18e59e9b2fe7",
      "IconId": "555a72f5-9e57-47d8-8723-abb9f5921853",
      "OperationalMode": "Active",
      "VideoMode": 0,
      "IsCollaborative": false,
      "DispathToSupervisorOnly": false
    }
  ]
}

The Web API was unable to process the request due to a client error (malformed request syntax, size too large, invalid request message framing, or deceptive request routing).

The token you submitted was either invalid or expired.

The token you submitted was valid, but either did not grant sufficient privilege to access the requested resource, or the Web API license is not active.

The Web API was unable to process the request.

The Web API received an invalid response from the Incident Manager role.

The Web API did not receive a response to the request. The Incident Manager role might be down at the moment.