Get Action List

Method: GET

Url: /Actions
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String:

Parameter Name Data Type Description
Parameter Name:

IncidentID (required)

Data Type:

Integer

Description:

The ID of the Incident to get actions for

Parameter Name:

ActionID (optional)

Data Type:

Integer

Description:

Filter actions by a specific ActionID

Default: -1

Parameter Name:

ActionDateFrom

Data Type:

String

Description:

Filter actions by the action date starting from.

Default: Null

Parameter Name:

ActionDateTo

Data Type:

String

Description:

Filter actions by the action date ending with.

Default: Null

Parameter Name:

CCWebUserID

Data Type:

String

Description:

Filter actions by CCWebUserID.

Default: Null

Parameter Name:

GetContentInHTML

Data Type:

Boolean

Description:

Whether to get the action description as HTML.

Default: True

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: StartDate^>=^''2019-12-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
Example: FirstName

Parameter Name:

SortOrder (optional)

Data Type:

String

Description:

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

Default: Empty string
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: FirstName, LastName, EmailAddress

Request Examples:
Using Filter Parameters:
GET "https://api.dataprise.com/api/v1/Actions/?IncidentID=1234&GetContentInHTML=true

Header: "DPApiAuthenticationToken=abcxyz0123456789"
Using JMS_Query:
GET "https://api.dataprise.com/api/v1/Actions/?IncidentID=1234&JMS_Query=ActionDate^>=^''2019-12-31''"

Header: "DPApiAuthenticationToken=abcxyz0123456789"
Paging & Sorting:
GET "https://api.dataprise.com/api/v1/Actions/?IncidentID=1234&PageNumber=2&PageSize=50&SortBy=ActionDescription&SortOrder=ASC"

Header: "DPApiAuthenticationToken=abcxyz0123456789"

Response:

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

ActionID

Data Type:

Integer

Remarks:

The unique ID of the record.

Column Name:

IncidentID

Data Type:

Integer

Remarks:

The ID of the incident

Column Name:

ActionDescription

Data Type:

String

Remarks:

The action description. May contain HTML

Column Name:

ActionDate

Data Type:

DateTime

Remarks:

The datetime the action was added to the incident

Column Name:

CCWebUserID

Data Type:

Integer

Remarks:

The ID of the user who added the action

Column Name:

EnteredBy

Data Type:

String

Remarks:

The name of the user who added the action

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