Get Incident List

Method: GET

Url: /Incidents
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String:

Parameter Name Data Type Description
Parameter Name:

IncidentID (optional)

Data Type:

Integer

Description:

Filter incidents by a specific IncidentID

Default: -1

Parameter Name:

Status (optional)

Data Type:

String

Description:

Filter incidents based on status "Open" or "Closed"

Default: "Open"

Parameter Name:

DateFrom (optional)

Data Type:

Date

Description:

Filter incidents opened on or after the specified date

Default: Null
Example: 2020-01-01

Parameter Name:

DateTo (optional)

Data Type:

Date

Description:

Filter incidents opened on or before the specified date

Default: Null
Example: 2020-01-31

Parameter Name:

GetContentInHTML

Data Type:

Boolean

Description:

Whether to get the incident's description as HTML.

Default: True

Parameter Name:

IncidentNo (optional)

Data Type:

String

Remarks:

Filter incidents by a unique alphanumeric key assigned to each incident
Default: Empty String

Parameter Name:

LastUpdateDateFrom (optional)

Data Type:

DateTime

Remarks:

To filter incidents by the last update date starting from
Default: Null

Parameter Name:

LastUpdateDateTo (optional)

Data Type:

DateTime

Remarks:

To filter incidents by the last update date ending with
Default: Null

Parameter Name:

ShortDescription (optional)

Data Type:

String

Remarks:

To filter incidents by short title of the incident
Default: Empty String

Parameter Name:

IncidentClassID (optional)

Data Type:

Integer

Remarks:

To filter incidents by the ClassID of the incident
Default: -1

Parameter Name:

IncidentSubClassID (optional)

Data Type:

Integer

Remarks:

To filter incidents by the SubClassID of the incident
Default: -1

Parameter Name:

IncidentPriority (optional)

Data Type:

String

Remarks:

To filter incidents by priority (Assigned Level) of the incident. May contain "Tier - 1", "Tier - 2", or "Tier - 3"
Default: Empty String

Parameter Name:

Disposition (optional)

Data Type:

String

Remarks:

To filter incidents by disposition for a closed incident. May contain either "Resolved" or "Unresolved"
Default: Empty String

Parameter Name:

UserID (optional)

Data Type:

Integer

Remarks:

To filter incidents by the ID of the Dataprise user the Incident is assigned to
Default: -1

Parameter Name:

CCWebUserID (optional)

Data Type:

Integer

Remarks:

To filter incidents by the ID of the Shared Operator user the Incident is assigned to
Default: -1

Parameter Name:

CCResponsibleDepartmentID (optional)

Data Type:

Integer

Remarks:

To filter incidents by the ID of the Shared Operator department the Incident is assigned to
Default: -1

Parameter Name:

TargetContactID (optional)

Data Type:

Integer

Remarks:

To filter incidents by the ID of the target contact of the incident
Default: -1

Parameter Name:

TargetDeviceID (optional)

Data Type:

Integer

Remarks:

To filter incidents by the ID of the target device of the incident
Default: -1

Parameter Name:

SubTargetDeviceID (optional)

Data Type:

Integer

Remarks:

The ID of the target device of the incident when the target is a contact
Default: -1

Parameter Name:

ResolvedDateFrom (optional)

Data Type:

DateTime

Remarks:

To filter incidents by the resolved date starting from (only applies to Closed incidents)
Default: Null

Parameter Name:

ResolvedDateTo (optional)

Data Type:

DateTime

Remarks:

To filter incidents by the resolved date ending with (only applies to Closed incidents)
Default: Null

Parameter Name:

JMS_Query (optional)

Data Type:

String

Description:

Any 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')

Parameter Name:

PageNumber (optional)

Data Type:

Integer

Description:

The number of page to retrieve considering the PageSize parameter.

Default: 1
Example: 4

Parameter Name:

PageSize (optional)

Data Type:

Integer

Description:

The 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

Parameter Name:

SortBy (optional)

Data Type:

String

Description:

The field name to sort the response by.

Default: Empty string (i.e. IncidentID)
Example: "ShortDescription"

Parameter Name:

SortOrder (optional)

Data Type:

String

Description:

Sort order. Can be either "ASC" or "DESC" or empty string denoting "ASC".

Default: Empty string (i.e. "ASC")
Example: "DESC"

Parameter Name:

tbl_columns (optional)

Data Type:

String

Description:

A 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=Closed

Header: "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 Name Data Type Remarks
Column Name:

IncidentID

Data Type:

Integer

Remarks:

The unique ID of the record.

Column Name:

IncidentNo

Data Type:

String

Remarks:

A unique alphanumeric key assigned to each incident

Column Name:

OpenDate

Data Type:

DateTime

Remarks:

The datetime the incident was opened

Column Name:

LastUpdateDate

Data Type:

DateTime

Remarks:

The datetime the incident was last updated

Column Name:

ShortDescription

Data Type:

String

Remarks:

A short title of the incident

Column Name:

LongDescription

Data Type:

String

Remarks:

Incident details. May contain HTML

Column Name:

IncidentClassID

Data Type:

Integer

Remarks:

The ClassID of the incident

Column Name:

IncidentClass

Data Type:

String

Remarks:

The Class of the incident

Column Name:

IncidentSubClassID

Data Type:

Integer

Remarks:

The SubClassID of the incident

Column Name:

IncidentSubClass

Data Type:

String

Remarks:

The SubClass of the incident

Column Name:

IncidentPerceivedPriority

Data Type:

String

Remarks:

The perceived priority of the incident. May contain "Low", "Normal", or "High"

Column Name:

IncidentPriority

Data Type:

String

Remarks:

The priority (Assigned Level) of the incident. May contain "Tier - 1", "Tier - 2", or "Tier - 3"

Column Name:

Status

Data Type:

String

Remarks:

The current status of the incident. May contain either "Open" or "Closed"

Column Name:

Disposition

Data Type:

String

Remarks:

The disposition for a closed incident. May contain either "Resolved" or "Unresolved"

Column Name:

DispositionNote

Data Type:

String

Remarks:

The disposition note for a closed incident.

Column Name:

IsIncidentPaused

Data Type:

Boolean

Remarks:

Whether the incident is currently paused.

Column Name:

UserID

Data Type:

Integer

Remarks:

The ID of the Dataprise user the Incident is assigned to

Column Name:

AssignedTo

Data Type:

String

Remarks:

The name of the Dataprise user the Incident is assigned to

Column Name:

CCWebUserID

Data Type:

Integer

Remarks:

The ID of the Shared Operator user the Incident is assigned to

Column Name:

CCAssignedTo

Data Type:

String

Remarks:

The name of the Shared Operator user the Incident is assigned to

Column Name:

CCResponsibleDepartmentID

Data Type:

Integer

Remarks:

The ID of the Shared Operator department the Incident is assigned to

Column Name:

CCResponsibleDepartment

Data Type:

String

Remarks:

The name of the Shared Operator department the Incident is assigned to

Column Name:

ResponsibleDepartment

Data Type:

String

Remarks:

The name of the Dataprise department the Incident is assigned to

Column Name:

TargetContactID

Data Type:

Integer

Remarks:

The ID of the target contact of the incident

Column Name:

TargetDeviceID

Data Type:

Integer

Remarks:

The ID of the target device of the incident

Column Name:

TargetDeviceName

Data Type:

Integer

Remarks:

The name of the target device of the incident

Column Name:

SubTargetDeviceID

Data Type:

Integer

Remarks:

The ID of the target device of the incident when the target is a contact

Column Name:

SubTargetDeviceName

Data Type:

String

Remarks:

The name of the target device of the incident when the target is a contact

Column Name:

ResolvedDate

Data Type:

DateTime

Remarks:

The datetime the incident was resolved, only applicable if the incident is closed or set to resolved.

Column Name:

TotalCount

Data Type:

Integer

Remarks:

Total number of records available for the specified query

Column Name:

CustomFields

Data Type:

List<CustomField>

Remarks:

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"
            }
        ]
    }
]
}