zentao-api / RequestOptions
Interface: RequestOptions
高阶 request("moduleName") / request("moduleName/methodName") / request("moduleName/<objectID>") 的单次调用选项。
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
autoFill? | boolean | 是否在执行 update 操作时自动填充未传入的字段。 设为 true 后，会先 GET 当前对象，把用户未显式传入（含 params.data）且 动作 body schema 中声明的字段用现值补齐，再发起 PUT，避免禅道用空值覆盖未提交字段。 因此只需传想修改的字段即可。仅对 type: 'update' 且模块存在 type: 'get' 动作时生效。 不传时回落到全局 autoFill，默认 false。 | - |
client? | ZentaoClient | 本次调用使用的客户端；优先级高于全局客户端。 | - |
convert? | (records) => DataRecord[] | 列表转换函数，在过滤前对记录数组整体执行。 | ProcessListOptions.convert |
convertSingle? | (record) => DataRecord | 单条对象转换函数，在字段摘取前执行；列表转换请使用 convert。 | - |
filter? | string[] | 过滤表达式组，如 ["status=active,pri>=2", "assignedTo.id=5"]；组内 AND、组间 OR，= 与 : 均表示相等。 | ProcessListOptions.filter |
insecure? | boolean | 本次调用 TLS 跳过证书验证选项；仅 Node.js 运行时支持。 | - |
limit? | string | 限制返回列表数量，在排序后、摘取前截断；不改变服务端页大小。 | ProcessListOptions.limit |
pick? | string[] | 摘取字段路径列表。 | ProcessListOptions.pick |
raw? | boolean | 是否返回原始响应体，默认 false。 | - |
recPerPage? | string | 本次调用使用的每页记录数，优先级高于全局 recPerPage。 | - |
search? | string[] | 模糊搜索关键词组，如 ["登录,超时", "注册,失败"]；组内 AND、组间 OR。 | ProcessListOptions.search |
searchFields? | string[] | 限定搜索字段，缺省时搜索全部字段。 | ProcessListOptions.searchFields |
sort? | string | 排序表达式，多个字段以英文逗号分隔；推荐 pri:desc,id:asc，兼容 pri_desc,id_asc。 | ProcessListOptions.sort |
throwOnFail? | boolean | 当禅道服务端返回 { status: "fail" } 时是否抛出 E_API_FAILED。 不传时回落到全局 throwOnFail，默认 false（保留原始失败响应）。 | - |
timeout? | number | 本次调用超时时间。 | - |