请求属性与XML应答

 

请求属性应和动作一起定义,对请求的操作还应满足SDP中对该用户所指派的只能角色一致(不能越权操作)。

 

注意: 定义的动作和属性都是区分大小写的,使用时必须严格按照以下定义的内容进行。

 



 

添加请求:

添加请求需要在请求参数中设置如下属性,并且应确保'operation'动作为'AddRequest'。

 

属性名称

描述

AddRequest

添加请求的操作命令

reqTemplate

请求模板的名称

description

请求的描述

resolution

请求的解决方法

requester

请求人

requesterEmail

请求人的电子邮件

priority

请求的优先级

level

请求的级别

status

请求的状态

mode

请求的模式

urgency

请求的紧急度

impact

请求的影响

requesttype

请求类型

site

地点

category

请求的分类

subcategory

子分类

item

项目

group

工作组

technician

技术员名

technicianEmail

技术员的电子邮件

UDF Alias Name

请求的自定义字段

username

登录SDP的用户名

password

该用户的登录密码

DOMAIN_NAME

该用户所属的域名。选择了域认证的情况下必须指定域名

logonDomainName

认证模式 [AD 或 本地认证]

AD_AUTH  代表活动目录认证

Local Authentication 或 空值 代表本地认证。

 

注意:

  1. 请求人技术员的识别依据是他们的用户名和邮件地址;

  2. 当以请求人登录创建请求时,地点字段将被设置为该请求人所在的地点;

  3. 对于技术员登录,如果地点为空值或NULL,则地点设置为 Not in Any Site

  4. 当以请求人登录创建请求时,如果在管理 -> 设置中选中“” 选项,则只能创建与他/她关联的资产所产生的请求;

  5. 如果一个技术员对于地点有访问限制,则他/她所创建的不与他/她关联的请求时,该请求的地点字段被设置为 'Not In Any Site';

  6. 创建请求时,如果主题为空,则被创建的请求的主题被设置为 '没有主题(no subject)';

  7. 如果某个字段在请求模板中不存在,则使用请求模板,通过API创建请求时,即使提供这些字段的值,也会被丢弃;

  8. 如果没有提供请求人的信息,则使用登录用户作为该请求的请求人;

  9. 创建请求时,如果没有提供某些必填项的值,则使用RequestServlet提供的值创建请求,并会记录响应的错误信息。

点击这里可查看创建请求的示例表单。  

HTML表单被提交到http://machine_name:Port_Number/servlets/RequestServlet ,并返回XML格式的应答消息,其中包括"成功消息"和被创建的请求ID。

如果无权创建请求,或者指定的地点与技术员没有关联,则返回失败消息 。 

 

更新请求:

在HTTP请求参数栏中必须输入参数‘workOrderID’[该参数为必填项],同时要将请求参数中的‘operation’设定为‘UpdateRequest’,其它要更新的内容与创建请求类似。请求人无权更新请求。

 

属性名称

描述

UpdateRequest

更新请求的操作命令

workOrderID

要更新的请求ID

reqTemplate

请求模板的名称

description

请求的描述

resolution

请求的解决方法

requester

请求人

requesterEmail

请求人的电子邮件

priority

优先级

level

级别

status

状态

mode

模式

urgency

紧急度

impact

影响

requesttype

请求类型

site

地点

category

分类

subcategory

子分类

item

项目

group

工作组

technician

技术员名称

technicianEmail

技术员的邮件地址

UDF Alias Name

请求的自定义字段

username

登录SDP的用户名

password

该用户的登录密码

DOMAIN_NAME

该用户所属的域名。选择了域认证的情况下必须指定域名

logonDomainName

认证模式 [AD 或 本地认证]

AD_AUTH  代表活动目录认证

Local Authentication 或 空值 代表本地认证。

 

注意:

  1. 请求人技术员的识别依据是他们的用户名和邮件地址;

  2. 空值将被设置为NULL

  3. 请求人不能更新请求。

点击这里查看示例表单。

正常的更新之后的应答消息为成功消息,如果技术员无权更新该请求,则返回失败消息 ,它们均为XML格式。

某种情况下,技术员可能无权执行某种操作,如:对于“只能查看指派给他的请求”的技术员就不能更新指派给其他技术员的请求。点击这里查看XML格式的应答消息。  

 

请求的指派:

请求的指派和更新请求的操作非常相似,区别在于指派请求只需要指定技术员和请求ID两个参数即可。 'operation'命令依然是 'UpdateRequest'。

指派/提取请求的表单与更新请求类似。请求将被指派给与对应地点关联的技术员。如果同时指定工作组,则请求指派给该工作组。如果请求被指派给未关联的地点的技术员,将会出错,请求不被指派。

 

关闭请求:

请求可通过两种方式关闭,请求人无权关闭请求。

属性名称

描述

CloseRequest

关闭请求的命令

workOrderID

要关闭的请求的ID

closeComment

关闭请求时的注释信息

username

登录SDP的用户名

password

该用户的登录密码

DOMAIN_NAME

该用户所属的域名。选择了域认证的情况下必须指定域名

logonDomainName

认证模式 [AD 或 本地认证]

AD_AUTH  代表活动目录认证

Local Authentication 或 空值 代表本地认证。

 

点击这里查看关闭请求的示例表单。

请求提交后成功时,将返回成功消息,如果指定的请求不存在,将返回"关闭失败的消息" ,技术员无权访问或无权关闭请求时,都会显示出错信息。点击这里 查看XML格式的应答信息。

 

删除请求:

要删除请求,只需指定 'workOrderID' 参数,并将'operation' 命令置为'DeleteRequest',请求人无权删除请求。

 

属性名称

描述

DeleteRequest

删除请求的命令

workOrderID

要删除的请求ID

username

登录SDP的用户名

password

该用户的登录密码

DOMAIN_NAME

该用户所属的域名。选择了域认证的情况下必须指定域名

logonDomainName

认证模式 [AD 或 本地认证]

AD_AUTH  代表活动目录认证

Local Authentication 或 空值 代表本地认证。

 

点击这里 查看删除请求的示例表单。操作成功后返回成功消息

删除失败时,将显示"出错消息"。

 

添加注释:

对请求添加注释,需要提供参数有:'Notes', 'isPublic', 'workOrderID' ,'operation'命令设置为'AddNotes'。

 

属性名称

描述

AddNotes

添加注释的操作命令

workOrderID

要添加注释的请求ID

notesText

注释的内容

isPublic

isPublic=true 添加公开的注释,请求人可查看

isPublic=false 添加私有的注释,技术员可查看

username

登录SDP的用户名

password

该用户的登录密码

DOMAIN_NAME

该用户所属的域名。选择了域认证的情况下必须指定域名

logonDomainName

认证模式 [AD 或 本地认证]

AD_AUTH  代表活动目录认证

Local Authentication 或 空值 代表本地认证。

 

点击这里 查看示例表单,应答消息可点击这里

 

获取请求:

要获取某个请求的详细信息,可指定'workOrderID' 参数,并将 'operation' 命令置为'GetRequestDetails'。请求人无权获取请求。

 

属性名称

描述

GetRequestDetails

获取请求明细的命令

workOrderID

要获取的请求 ID

username

登录SDP的用户名

password

该用户的登录密码

DOMAIN_NAME

该用户所属的域名。选择了域认证的情况下必须指定域名

logonDomainName

认证模式 [AD 或 本地认证]

AD_AUTH  代表活动目录认证

Local Authentication 或 空值 代表本地认证。

 

点击这里查看获取请求的表单示例。

得到的请求的明细为XML格式,您可以将它呈现在表单中。如果成功,则显示成功信息

如果失败,则显示出错信息



ServiceDeskPlus - 帮助台和资产管理软件
Copyright © 2006-2017 卓豪(北京)技术有限公司版权所有