Create a New Action

Method: POST

Url: /Actions
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String: None

Request Body:

Parameter Name Data Type Remarks
Parameter Name:

IncidentID (required)

Data Type:

Integer

Description:

The ID of the incident

Parameter Name:

ActionDescription (required)

Data Type:

String

Description:

The action description. May contain HTML

Parameter Name:

NewContentInHTML

Data Type:

Boolean

Description:

Whether the ActionDescription contains HTML

Default: True

Parameter Name:

CCWebUserID

Data Type:

Integer

Description:

The ID of the user who added the action

Default: -1

Column Name:

CustomFields

Data Type:

List<CustomField>

Remarks:

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

Request Example:
POST "https://api.dataprise.com/api/v1/Actions/"

Header: "DPApiAuthenticationToken=abcxyz0123456789"

Body:
		{
			"IncidentID": 4321,
			"ActionDescription": "Test action from API",
			"NewContentInHTML": false,
			"CustomFields": [{"FieldLabel": "Source", "FieldValue":"Email"}]
		}
		  

Response:

The API will return the response as under:

Property Data Type Remarks
Parameter Name:

Status

Data Type:

String

Description:

Status of the request. Either "Success" or "Failure"

Parameter Name:

Message

Data Type:

String

Description:

Error messages if the request failed (i.e. Status = "Failure")

Property:

Id

Data Type:

Integer

Description:

The ID of the created record if the request succeeded (i.e. Status = "Success")

Sample Response:
		{
			"Status": "Success",
			"Message": "",
			"Id": 415
		}