Create a New Incident

Method: POST

Url: /Incidents
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String: None

Request Body:

Parameter Name Data Type Remarks
Parameter Name:

ShortDescription (Required)

Data Type:

String

Description:

A short description of the incident

Parameter Name:

LongDescription

Data Type:

String

Description:

The details of the incident. May contain HTML

Parameter Name:

NewContentInHTML

Data Type:

Boolean

Description:

Whether the LongDescription contains HTML

Default: True

Parameter Name:

IncidentClassID

Data Type:

Integer

Description:

The ClassID of the incident

Default: -1

Parameter Name:

IncidentPerceivedPriority

Data Type:

String

Description:

The perceived priority of the incident. May contain “Low”, “Normal”, or “High”

Default: "Normal"

Parameter Name:

TargetContactID

Data Type:

Integer

Description:

The ID of the target contact of the incident.

Default: -1

Parameter Name:

TargetDeviceID

Data Type:

Integer

Description:

The ID of the target device of the incident

Default: -1

Parameter Name:

CreatedByContactID

Data Type:

Integer

Description:

The ID of the contact who created this incident.

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/Incidents/"

Header: "DPApiAuthenticationToken=abcxyz0123456789"

Body:
    {
        "ShortDescription": "Test incident from API",
        "LongDescription": "This is a test incident\r\nfrom API",
        "NewContentInHTML": false,
        "IncidentClassID": 405,
        "IncidentPerceivedPriority": "Normal",
        "TargetContactID": 73995,
        "TargetDeviceID": -1,
        "CustomFields": [
            {
                "FieldLabel": "Project",
                "FieldValue": "ASD"
            },
            {
                "FieldLabel": "Priority",
                "FieldValue": ""
            },
            {
                "FieldLabel": "Impact",
                "FieldValue": ""
            }
        ]
    }
		  

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