|
|
对于特定的请求，可以通过REST API为其添加新的注释，查看/更新/删除已有的注释。
注释相关操作的URL为：
添加注释:
http://<servername>:<port number>/sdpapi/request/<request id>/notes
对特定注释进行操作:
http://<servername>:<port number>/sdpapi/request/<request id>/notes/<notes id>
内容
以下将以ServiceDesk Plus 运行在本地服务器的8080端口（服务器名为"localhost"，端口号为 "8080"）为例，提供示例URL。
为某个请求添加注释的URL为：
http://<servername>:<port number>/sdpapi/request/<request id>/notes
假设请求ID为24，则示例URL：
http://localhost:8080/sdpapi/request/24/notes/
关键参数：
操作名称 - 属性名称为："OPERATION_NAME"，值为："ADD_NOTE"。
技术员密钥 - 属性名称为："TECHNICIAN_KEY"，值为：密钥的值。
输入数据 - （XML字符串）属性的名称为："INPUT_DATA"，值为具体的XML字符串。
|
注意: 请注意 输入和输出XML的格式已经更改，但是，为了兼容之前的API，输入操作将同时支持两种格式。
输入格式 1:
<Operation> <Details> <Notes> <Note> <parameter> <name>isPublic</name> <value>false</value> </parameter> <parameter> <name>notesText</name> <value>Text added to the note</value> </parameter> </Note> </Notes> </Details> </Operation>
输入格式 2:
<Operation> <Details> <Notes> <Note> <isPublic>false</isPublic> <notesText>Text added to the note</notesText> </Note> </Notes> </Details> </Operation>
输出:
<?xml version="1.0" encoding="UTF-8"?> <operation name="ADD_NOTE"> <result> <status>Success</status> <message>Note added successfully for request 24</message> </result> </operation> |
编辑请求的某个已有注释用的URL为：
http://<servername>:<port number>/sdpapi/request/<request id>/notes/<note id>
假设请求ID为24，注释ID为301，则示例URL为：
http://localhost:8080/sdpapi/request/24/notes/301
关键参数：
操作名称 - 属性名称为："OPERATION_NAME"，值为："EDIT_NOTE"。
技术员密钥 - 属性名称为："TECHNICIAN_KEY"，值为：密钥的值。
输入数据 - （XML字符串）属性的名称为："INPUT_DATA"，值为具体的XML字符串。
|
注意: 请注意 输入和输出XML的格式已经更改，但是，为了兼容之前的API，输入操作将同时支持两种格式。
输入格式 1:
<Operation> <Details> <Notes> <Note> <parameter> <name>notesText</name> <value>edited the subject</value> </parameter> </Note> </Notes> </Details> </Operation>
输入格式 2:
<Operation> <Details> <Notes> <Note> <notesText>edited sub</notesText> </Note> </Notes> </Details> </Operation>
输出:
<?xml version="1.0" encoding="UTF-8"?> <operation name="EDIT_NOTE"> <result> <status>Success</status> <message>Note 301 successfully edited for request 24</message> </result> </operation> |
要查看某个请求的特定注释用的URL为：
http://<servername>:<port number>/sdpapi/request/<request id>/notes/<note id>
假设请求ID为24，注释ID为301，则示例URL为：
http://localhost:8080/sdpapi/request/24/notes/301
关键参数：
操作名称 - 属性名称为："OPERATION_NAME"，值为："GET_NOTE"。
技术员密钥 - 属性名称为："TECHNICIAN_KEY"，值为：密钥的值。
输入数据 - 不需要。
|
注意: 请注意 输入和输出XML的格式已经更改，但是，为了兼容之前的API，输入操作将同时支持两种格式。
输出:
<?xml version="1.0" encoding="UTF-8"?> <operation name="GET_NOTE"> <result> <status>Success</status> <message>Note details fetched successfully</message> </result> <Details> <Notes> <Note> <parameter> <name>userid</name> <value>301</value> </parameter> <parameter> <name>ispublic</name> <value>false</value> </parameter> <parameter> <name>notesText</name> <value>Text added to the note</value> </parameter> <parameter> <name>username</name> <value>Shawn Adams</value> </parameter> <parameter> <name>notesid</name> <value>301</value> </parameter> <parameter> <name>notesdate</name> <value>1275373443722</value> </parameter> <parameter> <name>workorderid</name> <value>24</value> </parameter> </Note> </Notes> </Details> </Operation> |
查看某个请求的所有注释用户的URL为：
http://<servername>:<port number>/sdpapi/request/<request id>/notes/
假设请求ID为24，则示例URL为：
http://localhost:8080/sdpapi/request/24/notes
关键参数：
操作名称 - 属性名称为："OPERATION_NAME"，值为："GET_NOTES"。
技术员密钥 - 属性名称为："TECHNICIAN_KEY"，值为：密钥的值。
输入数据 - 不需要。
|
注意: 请注意 输入和输出XML的格式已经更改，但是，为了兼容之前的API，输入操作将同时支持两种格式。
输出:
<?xml version="1.0" encoding="UTF-8"?> <operation name="GET_NOTES"> <result> <status>Success</status> <message>Notes details fetched successfully</message> </result> <Details> <Notes> <Note URI="http://localhost:8080/sdpapi/request/24/notes/302/"> <parameter> <name>ispublic</name> <value>false</value> </parameter> <parameter> <name>notesText</name> <value>Note added to the request</value> </parameter> <parameter> <name>username</name> <value>Shawn Adams</value> </parameter> <parameter> <name>notesdate</name> <value>1275373948835</value> </parameter> </Note> <Note URI="http://localhost:8080/sdpapi/request/24/notes/301/"> <parameter> <name>ispublic</name> <value>false</value> </parameter> <parameter> <name>notesText</name> <value>Text added to the note</value> </parameter> <parameter> <name>username</name> <value>Shawn Adams</value> </parameter> <parameter> <name>notesdate</name> <value>1275373443722</value> </parameter> </Note> </Notes> </Details> </operation> |
要删除某个请求的特定注释用的URL为：
http://<servername>:<port number>/sdpapi/request/<request id>/notes/<note id>
假设请求ID为24，注释ＩＤ为３０１，则示例ＵＲＬ为：
http://localhost:8080/sdpapi/request/24/notes/301
关键参数：
操作名称 - 属性名称为："OPERATION_NAME"，值为："DELETE_NOTE"。
技术员密钥 - 属性名称为："TECHNICIAN_KEY"，值为：密钥的值。
输入数据 - 不需要。
|
注意: 请注意 输入和输出XML的格式已经更改，但是，为了兼容之前的API，输入操作将同时支持两种格式。
输出:
<?xml version="1.0" encoding="UTF-8"?> <operation name="DELETE_NOTE"> <result> <status>Success</status> <message>Note deleted successfully</message> </result> </operation>
|
|
|