Skip to content

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 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.
CustomFieldsList<CustomField>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” } ] }