Skip to content

Get list of incidents

Method: GET

Url: /Incidents
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String:

Parameter NameData TypeDescription
IncidentID (optional)IntegerFilter incidents by a specific IncidentID

Default: -1
Status (optional)StringFilter incidents based on status “Open” or “Closed”

Default: “Open”
DateFrom (optional)DateFilter incidents opened on or after the specified date

Default: Null
Example: 2020-01-01
DateTo (optional)DateFilter incidents opened on or before the specified date

Default: Null
Example: 2020-01-31
GetContentInHTMLBooleanWhether to get the incident’s description as HTML.

Default: True
IncidentNo (optional)StringFilter incidents by a unique alphanumeric key assigned to each incident
Default: Empty String
LastUpdateDateFrom (optional)DateTimeTo filter incidents by the last update date starting from
Default: Null
LastUpdateDateTo (optional)DateTimeTo filter incidents by the last update date ending with
Default: Null
ShortDescription (optional)StringTo filter incidents by short title of the incident
Default: Empty String
IncidentClassID (optional)IntegerTo filter incidents by the ClassID of the incident
Default: -1
IncidentSubClassID (optional)IntegerTo filter incidents by the SubClassID of the incident
Default: -1
IncidentPriority (optional)StringTo filter incidents by priority (Assigned Level) of the incident. May contain “Tier – 1”, “Tier – 2”, or “Tier – 3”
Default: Empty String
Disposition (optional)StringTo filter incidents by disposition for a closed incident. May contain either “Resolved” or “Unresolved”
Default: Empty String
UserID (optional)IntegerTo filter incidents by the ID of the Dataprise user the Incident is assigned to
Default: -1
CCWebUserID (optional)IntegerTo filter incidents by the ID of the Shared Operator user the Incident is assigned to
Default: -1
CCResponsibleDepartmentID (optional)IntegerTo filter incidents by the ID of the Shared Operator department the Incident is assigned to
Default: -1
TargetContactID (optional)IntegerTo filter incidents by the ID of the target contact of the incident
Default: -1
TargetDeviceID (optional)IntegerTo filter incidents by the ID of the target device of the incident
Default: -1
SubTargetDeviceID (optional)IntegerThe ID of the target device of the incident when the target is a contact
Default: -1
ResolvedDateFrom (optional)DateTimeTo filter incidents by the resolved date starting from (only applies to Closed incidents)
Default: Null
ResolvedDateTo (optional)DateTimeTo filter incidents by the resolved date ending with (only applies to Closed incidents)
Default: Null
JMS_Query (optional)StringAny SQL-compliant string to filter the records as explained here.

If the query contains any special or reserved characters, it must be properly escaped

Default: Empty string
Example: TargetContactID^=^73995%20^AND^(ShortDescription%20^LIKE^%20’%Test%’%20^OR^OpenDate^>=^’2019-08-31′)
PageNumber (optional)IntegerThe number of page to retrieve considering the PageSize parameter.

Default: 1
Example: 4
PageSize (optional)IntegerThe number of records to retrieve per request.

The page size cannot exceed the limit set for your account by Dataprise, which is usually around 100 records per request.

Default: 20
Example: 25
SortBy (optional)StringThe field name to sort the response by.

Default: Empty string (i.e. IncidentID)
Example: “ShortDescription”
SortOrder (optional)StringSort order. Can be either “ASC” or “DESC” or empty string denoting “ASC”.

Default: Empty string (i.e. “ASC”)
Example: “DESC”
tbl_columns (optional)StringA comma separated string containing the names of the columns to retrieve, instead of all columns.

Default: Empty string
Example: “IncidentID, IncidentNo, Status, ShortDescription”
Request Examples:
Using Filter Parameters:
GET “https://api.dataprise.com/api/v1/Incidents/?DateFrom=2020-01-01&DateTo=2020-01-10&Status=ClosedHeader: “DPApiAuthenticationToken=abcxyz0123456789”
Using JMS_Query:
GET “https://api.dataprise.com/api/v1/Incidents/?JMS_Query=TargetContactID^=^73995^AND^(ShortDescription^LIKE^’%Test%’^OR^OpenDate^>=^’2019-08-31′)”Header: “DPApiAuthenticationToken=abcxyz0123456789”
Paging & Sorting:
GET “https://api.dataprise.com/api/v1/Incidents/?PageNumber=2&PageSize=50&SortBy=ShortDesc&SortOrder=DESC”Header: “DPApiAuthenticationToken=abcxyz0123456789”

Response:

The API will return the list of matching incidents from your organization in JSON format. The response will by default contain the following fields for each record, however you can change that using the “tbl_columns” request parameter as mentioned above.

Column NameData TypeRemarks
IncidentIDIntegerThe unique ID of the record.
IncidentNoStringA unique alphanumeric key assigned to each incident
OpenDateDateTimeThe datetime the incident was opened
LastUpdateDateDateTimeThe datetime the incident was last updated
ShortDescriptionStringA short title of the incident
LongDescriptionStringIncident details. May contain HTML
IncidentClassIDIntegerThe ClassID of the incident
IncidentClassStringThe Class of the incident
IncidentSubClassIDIntegerThe SubClassID of the incident
IncidentSubClassStringThe SubClass of the incident
IncidentPerceivedPriorityStringThe perceived priority of the incident. May contain “Low”, “Normal”, or “High”
IncidentPriorityStringThe priority (Assigned Level) of the incident. May contain “Tier – 1”, “Tier – 2”, or “Tier – 3”
StatusStringThe current status of the incident. May contain either “Open” or “Closed”
DispositionStringThe disposition for a closed incident. May contain either “Resolved” or “Unresolved”
DispositionNoteStringThe disposition note for a closed incident.
IsIncidentPausedBooleanWhether the incident is currently paused.
UserIDIntegerThe ID of the Dataprise user the Incident is assigned to
AssignedToStringThe name of the Dataprise user the Incident is assigned to
CCWebUserIDIntegerThe ID of the Shared Operator user the Incident is assigned to
CCAssignedToStringThe name of the Shared Operator user the Incident is assigned to
CCResponsibleDepartmentIDIntegerThe ID of the Shared Operator department the Incident is assigned to
CCResponsibleDepartmentStringThe name of the Shared Operator department the Incident is assigned to
ResponsibleDepartmentStringThe name of the Dataprise department the Incident is assigned to
TargetContactIDIntegerThe ID of the target contact of the incident
TargetDeviceIDIntegerThe ID of the target device of the incident
TargetDeviceNameIntegerThe name of the target device of the incident
SubTargetDeviceIDIntegerThe ID of the target device of the incident when the target is a contact
SubTargetDeviceNameStringThe name of the target device of the incident when the target is a contact
ResolvedDateDateTimeThe datetime the incident was resolved, only applicable if the incident is closed or set to resolved.
TotalCountIntegerTotal number of records available for the specified query
CustomFieldsList<CustomField>List of custom fields (key-value pair) for this record
Sample Response:
{ “TotalCount”: 45, “Rows”: [ { “IsIncidentPaused”: false, “IncidentPerceivedPriority”: “Normal”, “Disposition”: “”, “DispositionNote”: “”, “ResolvedDate”: “”, “IncidentID”: 342561, “IncidentNo”: “SRI202002070001”, “OpenDate”: “2020-02-07T16:21:17.65”, “LastUpdateDate”: “2020-02-18T00:33:24”, “ShortDescription”: “Test 667234”, “LongDescription”: “Test 667234 – Description”, “Status”: “Open”, “IncidentPriority”: “TIER 1”, “Severity”: “SEV 1 – Single User Issue”, “IncidentClassID”: 403, “IncidentSubClassID”: 2225, “IncidentClass”: “Email/Outlook Problems”, “IncidentSubClass”: “Calendar Permissions”, “TargetContactID”: 3994, “TargetDeviceID”: -1, “TargetDeviceName”: “”, “SubTargetDeviceID”: 216, “SubTargetDeviceName”: “John’s iPhone”, “UserID”: -1, “AssignedTo”: “Doe, John”, “ResponsibleDepartment”: “Dataprise”, “CCWebUserID”: -1, “CCAssignedTo”: “”, “CCResponsibleDepartmentID”: -1, “CCResponsibleDepartment”: “”, “CustomFields”: [ { “FieldLabel”: “Project”, “FieldValue”: “ASD” }, { “FieldLabel”: “Impact”, “FieldValue”: “Moderate” } ] }, { “IsIncidentPaused”: false, “IncidentPerceivedPriority”: “Normal”, “Disposition”: “”, “DispositionNote”: “”, “ResolvedDate”: “”, “IncidentID”: 342559, “IncidentNo”: “SRI202001230005”, “OpenDate”: “2020-01-23T08:26:09.517”, “LastUpdateDate”: “2020-01-23T08:26:09.517”, “ShortDescription”: “Test incident by parameters from API”, “LongDescription”: “Test incident by parameters\r\nfrom API”, “Status”: “Open”, “IncidentPriority”: “TIER 1”, “Severity”: “SEV 1 – Single User Issue”, “IncidentClassID”: -1, “IncidentSubClassID”: -1, “IncidentClass”: “”, “IncidentSubClass”: “”, “TargetContactID”: 73995, “TargetDeviceID”: 125, “TargetDeviceName”: “Jane’s Mac”, “SubTargetDeviceID”: -1, “SubTargetDeviceName”: “”, “UserID”: -1, “AssignedTo”: “”, “ResponsibleDepartment”: “”, “CCWebUserID”: 125, “CCAssignedTo”: “Doe, Jane”, “CCResponsibleDepartmentID”: 4, “CCResponsibleDepartment”: “Cloud”, “CustomFields”: [ { “FieldLabel”: “Project”, “FieldValue”: “XYZ” }, { “FieldLabel”: “Impact”, “FieldValue”: “Severe” } ] } ] }