Skip to content

Get Action List

Method: GET

Url: /Actions
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String:

Parameter NameData TypeDescription
IncidentID (required)IntegerThe ID of the Incident to get actions for
ActionID (optional)IntegerFilter actions by a specific ActionID

Default: -1
ActionDateFromStringFilter actions by the action date starting from.

Default: Null
ActionDateToStringFilter actions by the action date ending with.

Default: Null
CCWebUserIDStringFilter actions by CCWebUserID.

Default: Null
GetContentInHTMLBooleanWhether to get the action description as HTML.

Default: True
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: StartDate^>=^”2019-12-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
Example: FirstName
SortOrder (optional)StringSort order. Can be either “ASC” or “DESC” or empty string denoting “ASC”.

Default: Empty string
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: FirstName, LastName, EmailAddress
Request Examples:
Using Filter Parameters:
GET “ “DPApiAuthenticationToken=abcxyz0123456789”
Using JMS_Query:
GET “^>=^”2019-12-31””Header: “DPApiAuthenticationToken=abcxyz0123456789”
Paging & Sorting:
GET “”Header: “DPApiAuthenticationToken=abcxyz0123456789”


The API will return the list of matching actions for the incidents for 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
ActionIDIntegerThe unique ID of the record.
IncidentIDIntegerThe ID of the incident
ActionDescriptionStringThe action description. May contain HTML
ActionDateDateTimeThe datetime the action was added to the incident
CCWebUserIDIntegerThe ID of the user who added the action
EnteredByStringThe name of the user who added the action
TotalCountIntegerTotal number of records available for the specified query
CustomFieldsList<CustomField>List of custom fields (key-value pair) for this record
Sample Response:
{ “TotalCount”: 5, “Rows”: [ { “IncidentID”: 1234, “ActionID”: 1677141, “ActionDescription”: “Incident set to resolved”, “ActionDate”: “2019-03-18T16:25:42”, “CCWebUserID”: -1, “EnteredBy”: “Doe, J.”, “TotalCount”: 7, “CustomFields”: null }, { “IncidentID”: 1234, “ActionID”: 1677140, “ActionDescription”: “Incident acknowledged”, “ActionDate”: “2019-03-18T16:25:25”, “CCWebUserID”: -1, “EnteredBy”: “Doe, J.”, “TotalCount”: 7, “CustomFields”: null }, { “IncidentID”: 1234, “ActionID”: 1677136, “ActionDescription”: “Incident status set to open”, “ActionDate”: “2019-03-18T16:22:39”, “CCWebUserID”: -1, “EnteredBy”: “Doe, J.”, “TotalCount”: 7, “CustomFields”: null } ] }