The following macros are not currently supported in the header:
  • style

确定标准字段的类型

服务器会确定标准的预定义数值字段可作为双精度 XML-RPC 类型处理,还是作为 i4 XML-RPC 类型处理。 通常,在小数位数是零时,服务器会选择使用类型 i4,在小数位数大于零时,选择使用双精度型。

在 XMLRPC 的 i4 类型只限于 4 字节整数。 它无法处理服务台整数字段支持的全范围整数值。 因此,对于小数位数大于零或精度大于 9 的数值字段,服务器将指示双精度型。

而对于通过 Service Desk WS API 传输的非常大的整数值(多于 15 或 16 位数),将没有任何精度损失。 客户端不应自行对此逻辑进行编码,而应使用在 describe 响应中指定的类型。

何时使用双精度型或 i4 类型的决定以后可能会变化。 然而,变更将反映到 describe 响应中。

本文包含以下主题:
                                                                                                        

枚举字段

在 Service Desk WS API 中,枚举字段是只能使用指定列表中的值的字段。 枚举字段在 describe 响应中通过“字段”子结构的“受限制”成员的布尔值“1”指示。 枚举字段所允许的值在 describe 响应的“显示”子结构的“值”数组中指定。

请注意,“值”成员存在于任何 picklist 型字段中,而不包含“受限制”成员的 picklist 字段是可选的。 在插入或更新时,Service Desk WS API 实施 picklist 字段的值列表。

query 调用总是返回值,而不是标签。 在任何用户界面中向用户显示值时,都应使用 describe 响应中该值的相应标签。

日期时间字段

所有日期/时间字段使用 XML-RPC 类型 dateTime.iso8601 或 SOAP 类型 dateTime 都通过 Service Desk WS API 传输。 然而,Service Desk 在内部对日期和时间采用两种不同的处理方式。

在某些情况下,您可以采用相同的方式处理日期/时间字段,但是在某些情况下,您可能需要以不同的方式处理。

常规日期/时间字段:

在 GMT 时间 1970 年 1 月 1 日午夜后,“常规日期/时间”字段作为秒数存储。 它们会在 GMT/UTC 时区间自动转换。 您无需将本地时间戳转换为 GMT/UTC 时区值。

常规“日期/时间”字段的示例包括所有“创建日期”字段、“开始日期/时间”字段和“结束日期/时间”字段。

仅日期字段

Service Desk 中的某些字段是仅日期字段。 “仅日期”字段的时间部分无关,并设为 GMT/UTC 时区的午夜。

由于 XMLRPC 没有“仅日期”类型,因此在 API 中,对于 SOAP,“仅日期”字段作为 dateTime 类型传输;对于 XML-RPC 调用,“仅日期”字段作为 dateTime.iso8601 类型传输。

考虑以下最佳实践:

  • 您应该使用与常规日期/时间值不同的方式处理“仅日期”字段值:
  • 忽略任何时间部分。
  • 将时间部分作为零发送。

Service Desk 接受包含非零时间部分的“仅日期”值。 然而,时间部分始终被截短到零。 请不要改变任何“仅日期”值以说明时区变化,因为时间部分没有意义。

自定义字段

在 Service Desk 用户界面中,组织可以针对不同实体定义一定数量的自定义字段。 通常,Service Desk WS API 的客户端不需要知道字段是该组织的标准字段还是自定义字段。

自定义字段有唯一的字段 ID,而不是用英文的 ID 名称。 该唯一字段 ID 在所有调用中总是以“cf_”作为前缀。 在提出请求时,您必须为所有自定义字段 ID 也加上字符串“cf_”作为前缀。 此限制不适用于 Service Desk WS API 的 XML-RPC 实施。

注意:所有数值自定义字段都作为整型处理。

ID 字段

ID 字段在插入时自动创建。 此字段在该记录的生命周期中无法更改,即使删除该记录再取消删除操作也是如此。 每个 ID 值都保证是全局唯一的。 为记录创建 ID 是唯一标识该记录的最好方法。 在插入或更新记录时,API 接受整数 ID。

交叉引用 ID 字段

很多实体都包含交叉引用 ID 字段,这些字段类似于数据库表中的外键字段。 在某些情况下,实体可以引用同类型的其他实体。 例如,故障单有一个可以指向其他故障单的父链接。

您也可以查询每个交叉引用的实体。 当您查询交叉引用 ID 字段时,它将返回相应类型的实体 ID。 然后,您可以使用该查询在 ID 字段中的 ID 进行查询以获取有关该实体的更多信息。

交叉引用 ID 字段值是您组织中的有效记录或空值(表示空引用)。

如果交叉引用 ID 字段值非空,将保证成为您组织的实体。 但是不能保证您可以查询该实体。

具有对该实体执行查询操作所需特权(权限)的组织用户可以查询该实体。 属于同一组织的其他用户可能会被限制查看或编辑被引用实体的权限。

在插入或更新记录时为交叉引用 ID 字段指定值也有具体的限制。 值必须是相应类型的有效实体。 用户必须具有对该实体的相应访问权限。

长文本字段

若干实体包含长文本字段(256 字节,4000 字节,等等),这些字段可以包含跨多行的数据。

您可以通过输入 ##NULL##,来清除非必需的文本字段。 但是,当您在强制字段中输入“##NULL##”时,将显示指示该字段为强制字段的标准消息。

系统修改时间戳字段

大多数实体具有标准的 systemModstamp 字段,该字段包含记录上次更改时的时间戳。 此字段自动地被维护。 您不能插入、更新或删除该字段。

 

© 2017 ServiceAide 1-650-206-8988 http://www.serviceaide.com info@serviceaide.com