对请求的操作,包括:添加新的请求,更新、关闭、删除、查看已有的请求。
对请求操作的URL格式如下:
添加新的请求:
http://<servername>:<port number>/sdpapi/request/
对特定请求的操作(查看/更新/关闭/删除):
http://<servername>:<port number>/sdpapi/request/<request id>
内容
以下将以ServiceDesk Plus 运行在本地服务器的8080端口(服务器名为"localhost",端口号为 "8080")为例,提供示例URL。
添加新的请求的URL格式为:
http://<servername>:<port number>/sdpapi/request/
示例URL:
http://localhost:8080/sdpapi/request/
关键参数:
作为POST方法的属性,需要指定以下参数(属性)
操作名称 - 属性名称为:"OPERATION_NAME",值为:"ADD_REQUEST"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输入 - 格式1 - 用于事故请求:
<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>
输入 - 格式2 - 用于事故请求: <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>
输入格式1 - 用于服务请求:
<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> 输出: "添加请求"操作的输出为XML格式: <?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> |
编辑请求的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>
假设请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/25
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"EDIT_REQUEST"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输入格式1 - 用于事故请求: <Operation> <Details> <parameter> <name>level</name> <value>Tier 3</value> </parameter> </Details> </Operation> 输入格式2 - 用于事故请求: <Operation> <Details> <level>Tier 3</level> </Details> </Operation> 输入格式1 - 用于服务请求: <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> 输出: <?xml version="1.0" encoding="UTF-8"?> <operation name="EDIT_REQUEST"> <result> <status>Success</status> <message>Request 25 successfully edited</message> </result> </operation> |
查看某个请求的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>
假设要查看的请求ID为24 ,则示例URL为:
http://localhost:8080/sdpapi/request/24/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_REQUEST"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出格式 - 用于事故请求: <?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> 输出格式 - 用于服务请求: <?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> |
删除某个请求的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>
假设要删除的请求ID为21,则示例URL为:
http://localhost:8080/sdpapi/request/21/
操作名称 - 属性名称为:"OPERATION_NAME",值为:"DELETE_REQUEST"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?xml version="1.0" encoding="UTF-8"?> <operation name="DELETE_REQUEST"> <result> <status>Success</status> <message>Request deleted successfully</message> </result> </operation> |
关闭请求的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>
假设要关闭的请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/25
关键参数:
操作名称 - 属性名称为:"CLOSE_REQUEST",值为:"DELETE_REQUEST"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 可选项,如果指定的话,属性名称为:"INPUT_DATA",值为XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
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>
|
获取请求的所有会话的URL:
http://<servername>:<port number>/sdpapi/request/<request id>/conversation/
假设请求ID为25,则示例URL:
http://localhost:8080/sdpapi/request/25/conversation/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_CONVERSATIONS"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出格式: <?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> |
要获取请求的某个会话,URL为:
http://<servername>:<port number>/sdpapi/request/<request id>/conversation/<conversationId>
假设请求ID为25,示例URL为:
http://localhost:8080/sdpapi/request/25/conversation/25
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_CONVERSATION"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (不需要)
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出格式: <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> |
为请求添加附件的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>/attachment
假设请求ID为25,示例URL为:
http://localhost:8080/sdpapi/request/25/attachment
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"ADD_ATTACHMENT "。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 附件文件。
注意: 请注意 输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
添加附件用的客户端代码示例: 以下以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> 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( );
} } |
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?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> |
为请求添加新的解决方法的URL为:
http://<servername>:<port number>/sdpapi/request/<request ID>/resolution
假设请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/ 25/resolution
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"ADD_RESOLUTION"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输入格式: <Details> <resolution> <resolutiontext>asd</resolutiontext> </resolution> </Details> 输出格式: <?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> |
编辑某个请求的解决方法的URL为:
http://<servername>:<port number>/sdpapi/request/<request ID>/ resolution
假设请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/25/ resolution
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"EDIT_RESOLUTION"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输入格式: <Details> <resolution> <resolutiontext>asd</resolutiontext> </resolution> </Details> 输出格式: <?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> |
从请求获取解决方法的URL为:
http://<servername>:<port number>/sdpapi/request/ <requestid>/
假设请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/25/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_RESOLUTION"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?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> |
提取请求的URL为:
http://<servername>:<port number>/sdpapi/request/ <requestid>/
假设请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/25/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"PICKUP_REQUEST"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?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> |
指派请求的URL为:
http://<servername>:<port number>/sdpapi/request/ <requestid>/
假设请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/25/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"ASSIGN_REQUEST"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输入: <?xml version="1.0" encoding="UTF-8"?> <Details> <parameter> <name>technicianid</name> <value>4</value> </paramter> </Details> |
输出: <?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> |
回复请求的URL为:
http://<servername>:<port number>/sdpapi/request/ <requestid>/
假设请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/25/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"REPLY_REQUEST"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输入: <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> |
输出: <?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> |
获取请求的URL为:
http://<servername>:<port number>/sdpapi/request/
示例URL为:
http://localhost:8080/sdpapi/request/
输入: <Details> <operation name="GET_REQUESTS"> <parameter> <name>from</name> <value>0</value> </parameter> <parameter> <name>limit</name> <value>25</value> </parameter> <parameter> <name>filter by</name> <value>All_Request</value> </parameter> </Details> |
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?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>
|
获取请求的某个通知的URL为:
http://<servername>:<port-number>/sdpapi/request/<requestId>/notification/<notificationId>
假设要获取请求ID为25的第10个通知,则示例URL为:
http://localhost:8080/sdpapi/request/25/ notification/10
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_NOTIFICATION"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?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>
|
获取某个请求的所有通知的URL为:
http://<servername>:<port-number>/sdpapi/request/<requestId>/notification/
假设请求ID为25,则URL为:
http://localhost:8080/sdpapi/request/25/ notification/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_NOTIFICATIONS"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?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>
|
获取某个请求的所有通知会话的URL为:
http://<servername>:<port-number>/sdpapi/request/<requestId>/allconversation/
假设请求ID为25,则示例URL为:
http://localhost:8080/sdpapi/request/25/allconversation/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_ALL_CONVERSATIONS"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?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> |
要获取请求关联的过滤器,URL为:
http://<servername>:<port-number>/sdpapi/request/
示例URL:
http://localhost:8080/sdpapi/request/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_REQUEST_FILTERS"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?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> |