对于特定的请求,可以通过REST API为其添加新的工作日志,查看/更新/删除已有的工作日志。
工作日志相关操作的URL为:
添加新的工作日志:
http://<servername>:<port number>/sdpapi/request/<request id>/worklogs
针对特定工作日志的操作:
http://<servername>:<port number>/sdpapi/request/<request id>/worklogs/<worklog id>
内容
以下将以ServiceDesk Plus 运行在本地服务器的8080端口(服务器名为"localhost",端口号为 "8080")为例,提供示例URL。
为某个请求添加工作日志的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>/worklogs
示例URL为: http://localhost:8080/sdpapi/request/24/worklogs/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"ADD_WORKLOG"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输入格式 1:
<Operation> <Details> <Worklogs> <Worklog> <parameter> <name>description</name> <value>Adding a New Worklog</value> </parameter> <parameter> <name>technician</name> <value>Howard Stern</value> </parameter> <parameter> <name>cost</name> <value>25</value> </parameter> <parameter> <name>workMinutes</name> <value>20</value> </parameter> <parameter> <name>workHours</name> <value>6</value> </parameter> </Worklog> </Worklogs> </Details> </Operation>
输入格式 2: <Operation> <Details> <Worklogs> <Worklog> <description>Adding a New Worklog</description> <technician>Howard Stern</technician> <cost>25</cost> <workMinutes>20</workMinutes> <workHours>6</workHours> </Worklog> </Worklogs> </Details> </Operation>
输出: <?xml version="1.0" encoding="UTF-8"?> <operation name="ADD_WORKLOG"> <result> <status>Success</status> <message>Work Log added successfully for request 24</message> </result> </operation> |
编辑某个工作日志的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>/worklogs/<work log id>
假设请求ID为24,工作日志ID为302,则示例URL为:
http://localhost:8080/sdpapi/request/24/worklogs/302
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"EDIT_WORKLOG"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - (XML字符串)属性的名称为:"INPUT_DATA",值为具体的XML字符串。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输入格式 1:
<Operation> <Details> <Worklogs> <Worklog> <parameter> <name>description</name> <value>Editing Worklog</value> </parameter> </Worklog> </Worklogs> </Details> </operation>
输入格式 2: <Operation> <Details> <Worklogs> <Worklog> <description>Editing Worklog</description> </Worklog> </Worklogs> </Details> </Operation>
输出: <?xml version="1.0" encoding="UTF-8"?> <operation name="EDIT_WORKLOG"> <result> <status>Success</status> <message>Work Log 302 successfully edited for request 24</message> </result> </operation>
|
查看某个请求的某个特定工作日志的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>/worklogs/<work log id>
假设请求ID为24,工作日志ID为302,则示例URL为:
http://localhost:8080/sdpapi/request/24/worklogs/302
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_WORKLOG"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?xml version="1.0" encoding="UTF-8"?> <operation name="GET_WORKLOG"> <result> <status>Success</status> <message>Work log details fetched successfully</message> </result> <Details> <Worklogs> <Worklog> <parameter> <name>dateTime</name> <value>1275375445281</value> </parameter> <parameter> <name>executedTime</name> <value>1275375433484</value> </parameter> <parameter> <name>cost</name> <value>21.6666666666667</value> </parameter> <parameter> <name>WORKORDERID</name> <value>24</value> </parameter> <parameter> <name>workHours</name> <value>0</value> </parameter> <parameter> <name>workMinutes</name> <value>7800000</value> </parameter> <parameter> <name>technician</name> <value>Howard Stern</value> </parameter> <parameter> <name>description</name> <value>Worklog 2</value> </parameter> <parameter> <name>requestCostID</name> <value>301</value> </parameter> </Worklog> </Worklogs> </Details> </Operation> |
查看某个请求的所有工作日志的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>/worklogs/
假设请求ID为24,工作日志ID为302,则示例URL为:
http://localhost:8080/sdpapi/request/24/worklogs/
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"GET_WORKLOGS"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。
输出: <?xml version="1.0" encoding="UTF-8"?> <operation name="GET_WORKLOGS"> <result> <status>Success</status> <message>Work log details fetched successfully</message> </result> <Details> <Worklogs> <Worklog URI="http://localhost:8080/sdpapi/request/24/worklogs/301/"> <parameter> <name>dateTime</name> <value>1275375445281</value> </parameter> <parameter> <name>executedTime</name> <value>1275375433484</value> </parameter> <parameter> <name>cost</name> <value>21.6666666666667</value> </parameter> <parameter> <name>WORKORDERID</name> <value>24</value> </parameter> <parameter> <name>workHours</name> <value>0</value> </parameter> <parameter> <name>workMinutes</name> <value>7800000</value> </parameter> <parameter> <name>technician</name> <value>Howard Stern</value> </parameter> <parameter> <name>description</name> <value>Worklog 2</value> </parameter> <parameter> <name>requestCostID</name> <value>301</value> </parameter> </Worklog> <Worklog URI="http://localhost:8080/sdpapi/request/24/worklogs/302/"> <parameter> <name>dateTime</name> <value>1275375861188</value> </parameter> <parameter> <name>executedTime</name> <value>1275375861188</value> </parameter> <parameter> <name>cost</name> <value>25.0</value> </parameter> <parameter> <name>WORKORDERID</name> <value>24</value> </parameter> <parameter> <name>workHours</name> <value>0</value> </parameter> <parameter> <name>workMinutes</name> <value>22800000</value> </parameter> <parameter> <name>technician</name> <value>Howard Stern</value> </parameter> <parameter> <name>description</name> <value>Adding a New Worklog</value> </parameter> <parameter> <name>requestCostID</name> <value>302</value> </parameter> </Worklog> <Worklogs> </Details> </operation>
|
从请求中删除某个工作日志的URL为:
http://<servername>:<port number>/sdpapi/request/<request id>/worklogs/<work log id>
假设请求ID为24,工作日志ID为301,则示例URL为: http://localhost:8080/sdpapi/request/24/worklogs/301
关键参数:
操作名称 - 属性名称为:"OPERATION_NAME",值为:"DELETE_WORKLOG"。
技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。
输入数据 - 不需要。
注意: 请注意 输入和输出XML的格式已经更改,但是,为了兼容之前的API,输入操作将同时支持两种格式。 输出: <?xml version="1.0" encoding="UTF-8"?> <operation name="DELETE_WORKLOG"> <result> <status>Success</status> <message>Work Log deleted successfully</message> </result> </operation> |