Update an Existing Service Request

Method: PUT

Url: /ServiceRequests
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String: None

Request Body:

Parameter Name Data Type Remarks
Parameter Name:

IncidentID (Required)

Data Type:

Integer

Description:

The unique ID of the service request to be updated

Parameter Name:

Status

Data Type:

String

Description:

The status of the service request if needs to be changed. May contain an empty string or “Open” or “Closed”

Default: Empty String (not to be changed)

Parameter Name:

ShortDescription

Data Type:

String

Description:

The short description of the service request if needs to be changed

Default: Empty String (not to be changed)

Parameter Name:

LongDescription

Data Type:

String

Description:

The details of the service request if needs to be changed

Default: Empty String (not to be changed)

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 service request if needs to be changed

Default: -1 (not to be changed)

Parameter Name:

IncidentPerceivedPriority

Data Type:

String

Description:

The perceived priority of the incident if needs to be changed. May contain “Low”, “Normal”, or “High”

Default: Empty String (not to be changed)

Column Name:

CustomFields

Data Type:

List<CustomField>

Remarks:

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

Request Example:
PUT "https://api.dataprise.com/api/v1/ServiceRequests/"

Header: "DPApiAuthenticationToken=abcxyz0123456789"

Body:
    {
        "IncidentID": 1234,
        "ShortDescription": "Test service request from API - Updated",
        "LongDescription": "Test serviece request from API <br/> Updated",
        "NewContentInHTML": true,
        "TargetContactID": 73995,
        "CustomFields": [
            {
                "FieldLabel": "Project",
                "FieldValue": "ASD"
            },
            {
                "FieldLabel": "Priority",
                "FieldValue": "High"
            },
            {
                "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 updated record if the request succeeded (i.e. Status = "Success")

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