Get Details of a Single Incident

Method: GET

Url: /Incidents/{IncidentID}[?GetContentInHTML=true|false] (e.g. /Incidents/1234/?GetContentInHTML=false)
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String:
GetContentInHTML (optional): Whether to get the ShortDescription in HTML format (default: true)

Request Example:
GET "https://api.dataprise.com/api/v1/Incidents/1234/?GetContentInHTML=false"

Header: "DPApiAuthenticationToken=abcxyz0123456789"

Response:

The API will return the details of the incident if the provided IncidentID is valid, with the following fields:

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:

CustomFields

Data Type:

List<CustomField>

Remarks:

List of custom fields (key-value pair) for this record

Sample Response:
    {
        "IncidentID": 342561,
        "IncidentNo": "SRI202002070001",
        "IsIncidentPaused": false,
        "IncidentPerceivedPriority": "Normal",
        "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": 45,
        "TargetDeviceName": "John's Mac",
        "SubTargetDeviceID": -1,
        "SubTargetDeviceName": "",
        "UserID": 1245,
        "AssignedTo": "Doe, John",
        "ResponsibleDepartment": "Dataprise",
        "CCWebUserID": -1,
        "CCAssignedTo": "",
        "CCResponsibleDepartmentID": -1,
        "CCResponsibleDepartment": "",
        "Disposition": "",
        "DispositionNote": "",
        "ResolvedDate": "",
        "CustomFields": [
            {
                "FieldLabel": "Project",
                "FieldValue": "ABC"
            },
            {
                "FieldLabel": "Impact",
                "FieldValue": "Moderate"
            }
        ]
    }