Request Operations

 

The operations on request such as adding new request, updating, closing, deleting and viewing the existing request are discussed under this section.

To perform operations on the request, the following URL patterns should be used.

 

For adding request:

http://<servername>:<port number>/sdpapi/request/

 

For operations on a specific request:

http://<servername>:<port number>/sdpapi/request/<request id>

 


Contents


 

Adding Request

Say, you are running ServiceDesk Plus with the server name "localhost" in the port "8080". You are creating a new request for the requester Shawn Adams, who is unable to browse the internet. The input and output XML formats for the above scenario are given below,

To add a new request, the URL is given as: 

http://<servername>:<port number>/sdpapi/request/

 

So for the scenario above, the URL is:

http://localhost:8080/sdpapi/request/

 

Key Points:

  1. The operation name "ADD_REQUEST"  should be sent as a "POST attribute" with key "OPERATION_NAME".

  2. The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY".

  3. Input is an XML string sent as a "POST attribute" with key "INPUT_DATA".

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Input - Format 1 for Incident Request:

 

<Operation>

<Details>

<parameter>

<name>requester</name>

<value>Shawn Adams</value>

</parameter>

<parameter>

<name>subject</name>

<value>The subject of the request</value>

</parameter>

<parameter>

<name>description</name>

<value>The description of the request</value>

</parameter>

<parameter>

<name>callbackURL</name>

<value>http://localhost:8080/CustomReportHandler.do</value>

</parameter>

<parameter>

<name>requesttemplate</name>

<value>Unable to browse</value>

</parameter>

<parameter>

<name>priority</name>

<value>High</value>

</parameter>

<parameter>

<name>site</name>

<value>New York</value>

</parameter>

<parameter>

<name>group</name>

<value>Network</value>

</parameter>

<parameter>

<name>technician</name>

<value>Howard Stern</value>

</parameter>

<parameter>

<name>level</name>

<value>Tier 3</value>

</parameter>

<parameter>

<name>status</name>

<value>Open</value>

</parameter>

<parameter>

<name>service</name>

<value>Email</value>

</parameter>

</Details>

</Operation>

 

 

Input - Format 2 for Incident Request:

 

<Operation>

<Details>

<requester>Shawn Adams</requester>

<subject>Specify Subject</subject>

<description>Specify Description</description>

<callbackURL>http://localhost:8080/CustomReportHandler.do</callbackURL>

<requesttemplate>Unable to browse</requesttemplate>

<priority>High</priority>

<site>New York</site>

<group>Network</group>

<technician>Howard Stern</technician>

<level>Tier 3</level>

<status>open</status>

<service>Email</service>

</Details>

</Operation>

 

Input - Format 1 for Service Request:

 

<Operation>

<Details>

<parameter>

<name>requesttemplate</name>

<value>Request a CRM account</value>

</parameter>

<parameter>

<name>technician</name>

<value>Howard Stern</value>

</parameter>

<parameter>

<name>level</name>

<value>Tier 3</value>

</parameter>

<resources>

<resource>

<title>System Requirements</title>

<parameter>

<name>Choose the desktop model</name>

<value>Dell</value>

</parameter>

<parameter>

<name>Choose the devices required</name>

<value>iPhone</value>

<value>Blackberry</value>

</parameter>

</resource>

<resource>

<title>Additional Requirements</title>

<parameter>

<name>Choose the additional hardware required</name>

<value>Optical Mouse</value>

</parameter>

</resource>

</resources>

<parameter>

<name>editor</name>

<value>administrator</value>

</parameter>

<parameter>

<name>serviceapprovers</name>

<value>administrator</value>

<value>guest</value>

</parameter>

<!--Common Additional Field-->

<parameter>

<name>Employee ID</name>

<value>0217</value>

</parameter>

<!--Service Category Specific Additional Field --!>

<parameter>

<name>RAM Size</name>

<value>8 GB</value>

</parameter>

</Details>

</Operation>

 

Output:

The Output format for the operation "Add Request" supports both the formats.

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="ADD_REQUEST">

<result>

<status>Success</status>

<message>Request added successfully</message>

</result>

<Details>

<workorderid>25</workorderid>

</Details>

<Details>

<parameter>

<name>workorderid</name>

<value>25</value>

</parameter>

</Details>

</operation>

 

 

Editing Request

To edit a request, the URL is given as: 

http://<servername>:<port number>/sdpapi/request/<request id>

 

Assume the Request ID to edit is 25, then the URL is: http://localhost:8080/sdpapi/request/25

 

Key Points:

  1. The operation name "EDIT_REQUEST"  should be sent as a "POST attribute" with key "OPERATION_NAME"

  2. The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY"

  3. Input is an XML string sent as "POST attribute" with key "INPUT_DATA".

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Input - Format 1 for Incident Request:

 

<Operation>

<Details>

<parameter>

<name>level</name>

<value>Tier 3</value>

</parameter>

</Details>

</Operation>

 

Input - Format 2 for Incident Request:

 

<Operation>

<Details>

<level>Tier 3</level>

</Details>

</Operation>

 

Input - Format 1 for Service Request:

 

<Operation>

<Details>

<resources>

<resource>

<title>System Requirements</title>

<parameter>

<name>Choose the desktop model</name>

<value>Dell</value>

</parameter>

<parameter>

<name>Choose the devices required</name>

<value>iPhone</value>

<value>Blackberry</value>

</parameter>

</resource>

<resource>

<title>Additional Requirements</title>

<parameter>

<name>Choose the additional hardware required</name>

<value>Optical Mouse</value>

</parameter>

</resource>

</resources>

<parameter>

<name>editor</name>

<value>administrator</value>

</parameter>

<!--Common Additional Field-->

<parameter>

<name>Employee ID</name>

<value>0217</value>

</parameter>

<!--Service Category Specific Additional Field --!>

<parameter>

<name>RAM Size</name>

<value>8 GB</value>

</parameter>

</Details>

</Operation>


Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="EDIT_REQUEST">

<result>

<status>Success</status>

<message>Request 25 successfully edited</message>

</result>

</operation>

 

 

Viewing Request

To view a request, the URL is given as: 

http://<servername>:<port number>/sdpapi/request/<request id>

 

Assume the Request ID to view is 24, then the URL is: http://localhost:8080/sdpapi/request/24/

 

Key points:

  1. The operation name "GET_REQUEST" should be sent as a "POST attribute" with key "OPERATION_NAME".

  2. The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY".

  3. Input is not required for viewing requests.

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

 

Output Format for Incident Request:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_REQUEST">

<result>

<status>Success</status>

<message>Request details fetched successfully</message>

</result>

<Details>

<parameter>

<name>workorderid</name>

<value>24</value>

</parameter>

<parameter>

<name>requester</name>

<value>Howard Stern</value>

</parameter>

<parameter>

<name>createdby</name>

<value>Howard Stern</value>

</parameter>

<parameter>

<name>createdtime</name>

<value>31 May 2011, 20:52:26</value>

</parameter>

<parameter>

<name>duebytime</name>

<value>01 Jun 2011, 10:00:00</value>

</parameter>

<parameter>

<name>timespentonreq</name>

<value>0hrs 0min</value>

</parameter>

<parameter>

<name>subject</name>

<value>The subject of the request</value>

</parameter>

<parameter>

<name>requesttemplate</name>

<value>Unable to browse</value>

</parameter>

<parameter>

<name>sla</name>

<value>High SLA</value>

</parameter>

<parameter>

<name>service</name>

<value>Email</value>

</parameter>

<parameter>

<name>technician</name>

<value>Howard Stern</value>

</parameter>

<parameter>

<name>status</name>

<value>Open</value>

</parameter>

<parameter>

<name>priority</name>

<value>High</value>

</parameter>

<parameter>

<name>level</name>

<value>Tier 3</value>

</parameter>

<parameter>

<name>group</name>

<value>Network</value>

</parameter>

<parameter>

<name>description</name>

<value>The description of the request</value>

</parameter>

<Notes URI="http://localhost:8080/sdpapi/request/24/notes/"/>

<Worklogs URI="http://localhost:8080/sdpapi/request/24/worklogs/"/>

</Details>

</Operation>

 

Output Format for Service Request:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_REQUEST">

<result>

<status>Success</status>

<message>Request details fetched successfully</message>

</result>

<Details>

<parameter>

<name>workorderid</name>

<value>24</value>

</parameter>

<parameter>

<name>requester</name>

<value>Howard Stern</value>

</parameter>

<parameter>

<name>createdby</name>

<value>Howard Stern</value>

</parameter>

<parameter>

<name>createdtime</name>

<value>31 May 2011, 20:52:26</value>

</parameter>

<parameter>

<name>duebytime</name>

<value>01 Jun 2011, 10:00:00</value>

</parameter>

<parameter>

<name>timespentonreq</name>

<value>0hrs 0min</value>

</parameter>

<parameter>

<name>subject</name>

<value>Please provide me an account in our CRM system</value>

</parameter>

<parameter>

<name>requesttemplate</name>

<value>Request a CRM account</value>

</parameter>

<parameter>

<name>service</name>

<value>Email</value>

</parameter>

<parameter>

<name>technician</name>

<value>Howard Stern</value>

</parameter>

<parameter>

<name>status</name>

<value>Open</value>

</parameter>

<parameter>

<name>priority</name>

<value>High</value>

</parameter>

<parameter>

<name>level</name>

<value>Tier 3</value>

</parameter>

<parameter>

<name>group</name>

<value>Network</value>

</parameter>

<parameter>

<name>description</name>

<value>The description of the request</value>

</parameter>

<resources>

<resource>

<title>System Requirements</title>

<parameter>

<name>Choose the desktop model</name>

<value>Dell</value>

</parameter>

<parameter>

<name>Choose the devices required</name>

<value>iPhone</value>

<value>Blackberry</value>

</parameter>

<resource>

<title>Additional Requirements</title>

<parameter>

<name>Choose the additional hardware required</name>

<value>Optical Mouse</value>

</parameter>

</resource>

</resources>

<parameter>

<name>editor</name>

<value>vidhya</value>

</parameter>

<Notes URI="http://localhost:8080/sdpapi/request/24/notes/"/>

<Worklogs URI="http://localhost:8080/sdpapi/request/24/worklogs/"/>

</Details>

</Operation>

 

 

 

Deleting Request

To delete a request, the URL is given as: 

http://<servername>:<port number>/sdpapi/request/<request id>

 

Assume the Request ID to delete is 21, then the URL is: http://localhost:8080/sdpapi/request/21/

 

Key points:

  1. The operation name "DELETE_REQUEST" should be sent as a "POST attribute" with key "OPERATION_NAME".

  2. The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY".

  3. Input is not required for deleting requests.

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="DELETE_REQUEST">

<result>

<status>Success</status>

<message>Request deleted successfully</message>

</result>

</operation>

 

 

Close Request

To close a request, the URL is given as: 

http://<servername>:<port number>/sdpapi/request/<request id>

 

Assume the Request ID to close is 25, then the URL is given as: http://localhost:8080/sdpapi/request/25

 

Key points:

  1. The operation name "CLOSE_REQUEST" should be sent as a "POST attribute" with key "OPERATION_NAME".

  2. The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY".

  3. The input XML is optional. If specified, then the input is an XML string sent as "POST attribute" with key "INPUT_DATA".

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Input - Format 1:

 

<Operation>

<Details>

<parameter>

<name>closeAccepted</name>

<value>Accepted</value>

</parameter>

<parameter>

<name>closeComment</name>

<value>The Closing Comment</value>

</parameter>

</Details>

</Operation>

 

 

 





Get Conversations

To get conversation of all requests, the URL is given as: 

http://<servername>:<port number>/sdpapi/request/<request id>/conversation/

 

Assume the Request ID is 25,then the URL is given as: http://localhost:8080/sdpapi/request/25/conversation/


Key points:

  1. The operation name "GET_CONVERSATIONS " should be sent as a "POST attribute" with key "OPERATION_NAME".

  2. The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY".

  3. Input is not required for Get Request Conversations

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output Format:


<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_CONVERSATIONS">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Conversation details fetched successfully</message>

</result>

<Details type="conversation">

<record URI="http://<servername>:<port-number>/sdpapi/request/<requestId>/conversation/1">

<parameter>

<name>CONVERSATION ID<name>

<value>1<value>

</parameter>

<parameter>

<name>FROM<name>

<value>administrator<value>

</parameter>

<parameter>

<name>CREATEDTIME<name>

<value>1343844854421<value>

</parameter>

<parameter>

<name>TYPE<name>

<value>MERGE<value>

</parameter>

</record>

<record URI="http://<servername>:<port-number>/sdpapi/request/<requestId>/conversation/2">

<parameter>

<name>CONVERSATION ID<name>

<value>2<value>

</parameter>

<parameter>

<name>FROM<name>

<value>administrator<value>

</parameter>

<parameter>

<name>CREATEDTIME<name>

<value>1343844854421<value>

</parameter>

<parameter>

<name>TYPE<name>

<value>MERGE<value>

</parameter>

</record>

</Details>

</operation>



Get Conversation

To get conversation of a request, the URL is given as: 

http://<servername>:<port number>/sdpapi/request/<request id>/conversation/<conversationId>

 

Assume the Request ID is 25 and the Conversation ID is also 25, then the URL is given as: http://localhost:8080/sdpapi/request/25/conversation/25


Key points:

  1. The operation name "GET_CONVERSATION " should be sent as a "POST attribute" with key "OPERATION_NAME".

  2. The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY".

  3. Input is not required for Get Request Conversation

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output Format:


<xml version="1.0" encoding="UTF-8">

<operation name="GET_CONVERSATION">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Conversation details fetched successfully</message>

</result>

<Details type="conversation">

<record>

<parameter>

<name>CONVERSATION ID<name>

<value>1<value>

</parameter>

<parameter>

<name>TITLE<name>

<value>title<value>

</parameter>

<parameter>

<name>DESCRIPTION<name>

<value>description<value>

</parameter>

<parameter>

<name>TOADDRESS<name>

<value>xyz@abc.com<value>

</parameter>

<parameter>

<name>CCADDRESS<name>

<value>xyz@abc.com<value>

</parameter>

</record>

</Details>

</operation>



Add Attachment

To append attachments to requests, the URL is given as: 

http://<servername>:<port number>/sdpapi/request/<request id>/attachment

 

Assume the Request ID is 25,then the URL is given as: http://localhost:8080/sdpapi/request/25/attachment


Key points:

  1. The operation name "ADD_ATTACHMENT " should be sent as a "POST attribute" with key "OPERATION_NAME".

  2. The technician key should be sent as a "POST attribute" with key "TECHNICIAN_KEY".


Note: Please note that the Output XML format has been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Attachment Client Side Snippet:


The snippet provided below is an example of how you can append "Attachments to Requests" written in java.


{

/**

* 1. Create a MultipartPostMethod

* 2. Construct the web URL to connect to the SDP Server

* 3. Add the filename to be attached as a parameter to the MultipartPostMethod with parameter name "filename"

* 4. Execute the MultipartPostMethod

* 5. Receive and process the response as required

* /

HttpClient client = new HttpClient( );

String weblinkURL = "http://<SDPServer>:<PortNumber>/sdpapi/request/<requestId> /attachment?OPERATION_NAME=ADD_ATTACHMENT&TECHNICIAN_KEY=<general technician API key>";

MultipartPostMethod method = new MultipartPostMethod( weblinkURL );

String fileName = "C:" + File.pathSeparator + "ManageEngine" + File.pathSeparator + "ServiceDesk" + File.pathSeparator + "a.csv";

File file = new File(fileName);

method.addParameter("filename", file );


try {

client.executeMethod( method );

String response = method.getResponseBodyAsString();

System.out.println( response );

} catch  (HttpException he) {

System.out.println( he );

} catch (Exception e) {

System.out.println( e );

} finally {

method.releaseConnection( );

}

}



Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="ADD_ATTACHMENT">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Attachments added successfully</message>

</result>

<Details type="attachment"/>

</operation>

 



Adding Resolution

To add new resolution to a request, the URL should be given as:

http://<servername>:<port number>/sdpapi/request/<request ID>/resolution

 

Assume the Request ID is 25,then the URL is given as:

http://localhost:8080/sdpapi/request/ 25/resolution

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Input Format:

 

<Details>

<resolution>

<resolutiontext>asd</resolutiontext>

</resolution>

</Details>

 

Output Format:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="ADD_RESOLUTION">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Resolution added Successfully</message>

</result>

</operation>

 

 

Editing Resolution

To edit a resolution to a request, the URL should be given as:

http://<servername>:<port number>/sdpapi/request/<request ID>/ resolution

 

Assume the Request ID is 25,then the URL is given as:

http://localhost:8080/sdpapi/request/25/

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Input Format:

 

<Details>

<resolution>

<resolutiontext>asd</resolutiontext>

</resolution>

</Details>

 

Output Format:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation ssname="EDIT_RESOLUTION">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Resolution edited Successfully for request<request ID></message>

</result>

</operation>

 



Get Resolution

To get a resolution, the URL should be given as:

http://<servername>:<port number>/sdpapi/request/ <requestid>/

 

Assume the Request ID is 25,then the URL is given as:

http://localhost:8080/sdpapi/request/25/

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_RESOLUTION">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Resolution details fetched Successfully for request<requestid></message>

</result>

<Details>

<resolution>resolution</resolution>

<lastupdatedtime>1352100738881</lastupdatedtime>

<resolver>301</resolver>

</Details>

</operation>

 

 

Pickup Request

To pick up request, the URL should be given as:

http://<servername>:<port number>/sdpapi/request/ <requestid>/

 

Assume the Request ID is 25,then the URL is given as:

http://localhost:8080/sdpapi/request/25/

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="PICKUP_REQUEST">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Request picked up Successfully</message>

</result>

</operation>

 

 

Assign Request

To assign request, the URL should be given as:

http://<servername>:<port number>/sdpapi/request/ <requestid>/

 

Assume the Request ID is 25,then the URL is given as:

http://localhost:8080/sdpapi/request/25/

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Input:

 

<?xml version="1.0" encoding="UTF-8"?>

<Details>

<parameter>

<name>technicianid</name>

<value>4</value>

</paramter>

</Details>

 



Output:

<?xml version="1.0" encoding="UTF-8"?>

<operation name="ASSIGN_REQUEST">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Request assigned Successfully</message>

</result>

</operation>

 

 

Reply Request

To assign request, the URL should be given as:

http://<servername>:<port number>/sdpapi/request/ <requestid>/

 

Assume the Request ID is 25,then the URL is given as:

http://localhost:8080/sdpapi/request/25/

 


Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Input:

 

<Details>

<parameter>

<name>to</name>

<value>vivin@sdplinmail.com</value>

</parameter>

<parameter>

<name>cc</name>

<value>vivin@sdplinmail.com</value>

</parameter>

<parameter>

<name>subject</name>

<value>subject text</value>

</parameter>

<parameter>

<name>description</name>

<value>description text</value>

</parameter>

</Details>

 


Output:

<?xml version="1.0" encoding="UTF-8"?>

<operation name="REPLY_REQUEST">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Request assigned Successfully</message>

</result>

</operation>

 

 

Get Requests

To get request, the URL should be given as:

http://<servername>:<port number>/sdpapi/request/

 

Assume the Request ID is 25,then the URL is given as:

http://localhost:8080/sdpapi/request/

 

Input:

<Details>

<parameter>

<name>from</name>

<value>0</value>

</parameter>

<parameter>

<name>limit</name>

<value>25</value>

</parameter>

<parameter>

<name>filterby</name>

<value>All_Requests</value>

</parameter>

</Details>

 



Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_REQUEST">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message>Request replied Successfully</message>

</result>

<Details type="GET_REQUESTS">

<record URL="http://localhost:8080/sdpapi/request/<requestid>

<parameter>

<name>workorderid</name>

<value><requestid></value>

</parameter>

</parameter>

<name>requester</name>

<value>administrator</value>

</parameter>

<name>createdby</name>

<value>administrator</value>

</parameter>

</parameter>

<name>createdtime</name>

<value>12321434324324</value>

</parameter>

</parameter>

<name>duebytime</name>

<value>11234321412454</value>

</parameter>

</parameter>

<name>subject</name>

<value>subject</value>

</parameter>

</parameter>

<name>technician</name>

<value>administrator</value>

</parameter>

</parameter>

<name>priority</name>

<value>High</value>

</parameter>

</parameter>

<name>status</name>

<value>open</value>

</parameter>

</parameter>

<name>isoverdue</name>

<value>false</value>

</parameter>

</record>

<record URL="http://localhost:8080/sdpapi/request/<requestid>"

<parameter>

<name>workorderid</name>

<value><requestid></value>

<parameter>

<name>requester</name>

<value>administrator</value>

<parameter>

<parameter>

<name>createdby</name>

<value>administrator</value>

<parameter>

<parameter>

<name>createdtime</name>

<value>1232143323543</value>

<parameter>

<parameter>

<name>duebytime</name>

<value>1123432143534</value>

<parameter>

<parameter>

<name>subject</name>

<value>subject</value>

<parameter>

<parameter>

<name>technician</name>

<value>administrator</value>

<parameter>

<parameter>

<name>priority</name>

<value>High</value>

<parameter>

<parameter>

<name>status</name>

<value>open</value>

<parameter>

<parameter>

<name>isoverdue</name>

<value>false</value>

<parameter>

</record>

</Details>

</operation>


 

Get Notification

To get notifications of a request, the URL should be given as:

http://<servername>:<port-number>/sdpapi/request/<requestId>/notification/<notificationId>

 

Assume the Request ID is 25 and the notification is 10, then the URL is given as:

http://localhost:8080/sdpapi/request/25/ notification/10

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_NOTIFICATION">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message> Notification details fetched successfully</message>

</result>

<Details type="GET_NOTIFICATION">

<record>

<parameter>

<name>NOTIFYID</name>

<value>1</value>

</parameter>

<parameter>

<name>FROM</name>

<value>administrator</value>

</parameter>

<parameter>

<name>CREEATEDDATE</name>

<value>1343844854421</value>

</parameter>

<parameter>

<name>TITLE</name>

<value>Re: [Request ID :##1##] : asdasd</value>

</parameter>

<parameter>

<name>DESCRIPTION</name>

<value><p>Category : <br />Description : </p></value>

</parameter>

<parameter>

<name>TOADDRESS</name>

<value>abc@sdplinmail.com</value>

</parameter>

<parameter>

<name>CCADDRESS</name>

<value>xyz@sdplinmail.com</value>

</parameter>

<parameter>

<name>TYPE</name>

<value>Notification</value>

</parameter>

<parameter>

<name>SUBTYPE</name>

<value>REQREPLY</value>

</parameter>

</record>

</Details>

</Operation>

 

 

 

 

Get Notifications

To get notifications of a request, the URL should be given as:

http://<servername>:<port-number>/sdpapi/request/<requestId>/notification/

 

Assume the Request ID is 25, then the URL is given as:

http://localhost:8080/sdpapi/request/25/ notification/

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_NOTIFICATIONS">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message> Notification details fetched successfully</message>

</result>

<Details type="GET_NOTIFICATIONS">

<record URI="http://<servername>:<port-number>/sdpapi/request/<requestId>/notification/1">

<parameter>

<name>NOTIFYID</name>

<value>1</value>

</parameter>

<parameter>

<name>FROM</name>

<value>administrator</value>

</parameter>

<parameter>

<name>CREEATEDDATE</name>

<value>1343844854421</value>

</parameter>

<parameter>

<name>TYPE</name>

<value>Notification</value>

</parameter>

<parameter>

<name>SUBTYPE</name>

<value>REQREPLY</value>

</parameter>

</record>

<record URI="http://<servername>:<port-number>/sdpapi/request/<requestId>/notification/2">

<parameter>

<name>NOTIFYID</name>

<value>2</value>

</parameter>

<parameter>

<name>FROM</name>

<value>administrator</value>

</parameter>

<parameter>

<name>CREEATEDDATE</name>

<value>1343844834134</value>

</parameter>

<parameter>

<name>TYPE</name>

<value>Notification</value>

</parameter>

<parameter>

<name>SUBTYPE</name>

<value>REQFORWARD</value>

</parameter>

</record>

</Details>

</Operation>

 

 

 

 

Get All Conversations

To get notifications of a request, the URL should be given as:

http://<servername>:<port-number>/sdpapi/request/<requestId>/allconversation/

 

Assume the Request ID is 25, then the URL is given as:

http://localhost:8080/sdpapi/request/25/allconversation/

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_ALL_CONVERSATIONS">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message> Notification details fetched successfully</message>

</result>

<Details type="GET_ALL_CONVERSATIONS">

<record URI="http://<servername>:<port-number>/sdpapi/request/<requestId>/allconversation/1343844854421">

<parameter>

<name>NOTIFYID</name>

<value>1</value>

</parameter>

<parameter>

<name>FROM</name>

<value>administrator</value>

</parameter>

<parameter>

<name>CREEATEDDATE</name>

<value>1343844854421</value>

</parameter>

<parameter>

<name>TYPE</name>

<value>Notification</value>

</parameter>

<parameter>

<name>SUBTYPE</name>

<value>REQREPLY</value>

</parameter>

<parameter>

<name>DESCCRIPTION</name>

<value></value>

</parameter>

</record>

<record URI="http://<servername>:<port-number>/sdpapi/request/<requestId>/allconversation/1343844834134">

<parameter>

<name>NOTIFYID</name>

<value>2</value>

</parameter>

<parameter>

<name>FROM</name>

<value>administrator</value>

</parameter>

<parameter>

<name>CREEATEDDATE</name>

<value>1343844834134</value>

</parameter>

<parameter>

<name>TYPE</name>

<value>Notification</value>

</parameter>

<parameter>

<name>SUBTYPE</name>

<value>REQFORWARD</value>

</parameter>

<parameter>

<name>DESCRIPTION</name>

<value></value>

</parameter>

</record>

<record URI="http://<servername>:<port-number>/sdpapi/request/<requestId>/allconversation/1357110660162">

<parameter>

<name>CONVERSATION ID</name>

<value>1</value>

</parameter>

<parameter>

<name>FROM</name>

<value>guest</value>

</parameter>

<parameter>

<name>CREEATEDDATE</name>

<value>1357110660162</value>

</parameter>

<parameter>

<name>TYPE</name>

<value>Conversation</value>

</parameter>

<parameter>

<name>DESCRIPTION</name>

<value></value>

</parameter>

</record>

</Details>

</Operation>

 




 

Get Request Filters

To fetch various filters associated with requests, the URL should be given as:

http://<servername>:<port-number>/sdpapi/request/

 

Sample URL:

http://localhost:8080/sdpapi/request/

 

Note: Please note that the Input and Output XML formats have been changed. But for compatibility reasons, the Input operation will support both the formats.

 

Output:

 

<?xml version="1.0" encoding="UTF-8"?>

<operation name="GET_REQUEST_FILTERS">

<result>

<statuscode>200</statuscode>

<status>Success</status>

<message> Request Filters fetched successfully</message>

</result>

<Details>

<Filters>

<parameter>

<name>MyOpen_Or_Unassigned</name>

<value>My Open Or Unassigned</value>

</parameter>

<parameter>

<name>Unassigned_System</name>

<value>Unassigned Requests</value>

</parameter>

<parameter>

<name>Open_User</name>

<value>My Open Requests</value>

</parameter>

<parameter>

<name>Onhold_User</name>

<value>My Requests On Hold</value>

</parameter>

<parameter>

<name>Overdue_User</name>

<value>My Overdue Requests</value>

</parameter>

<parameter>

<name>All_Pending_User</name>

<value>All_Pending_Requests_Tasks_User</value>

</parameter>

<parameter>

<name>Due_Today_User</name>

<value>My Requests Due Today </value>

</parameter>

<parameter>

<name>All_Completed_User</name>

<value>All My Requests</value>

</parameter>

<parameter>

<name>My_Pending_Approval</name>

<value>Requests Pending My Approval </value>

</parameter>

<parameter>

<name>All_User</name>

<value>All My Requests</value>

</parameter>

<parameter>

<name>Open_System</name>

<value>Open Requests</value>

</parameter>

<parameter>

<name>Onhold_System</name>

<value>Overdue Requests</value>

</parameter>

<parameter>

<name>Overdue_System_Today</name>

<value>Requests Due Today</value>

</parameter>

<parameter>

<name>Pending_Approval</name>

<value>Requests Pending Approval</value>

</parameter>

<parameter>

<name>All_Pending</name>

<value>Completed Requests</value>

</parameter>

<parameter>

<name>All_Completed</name>

<value>Conversation</value>

</parameter>

<parameter>

<name>Waiting_Update</name>

<value>Waiting for my update</value>

</parameter>

<parameter>

<name>Updated_By_Me</name>

<value>Updated by me</value>

</parameter>

<parameter>

<name>All_Requests</name>

<value>All Requests</value>

</parameter>

</Filters>

</Details>

</Operation>

 



ServiceDeskPlus - Help Desk and Asset Management Software

Copyright © 2012, ZOHO Corp. All Rights Reserved.
ManageEngine