zentao-api / RequestOptions
Interface: RequestOptions
高阶 request("moduleName") / request("moduleName/methodName") / request("moduleName/<objectID>") 的单次调用选项。
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
client? | ZentaoClient | 本次调用使用的客户端；优先级高于全局客户端。 | - |
filter? | string[] | 过滤表达式列表，例如 ["status=active", "pri>=2"]，多条之间按 AND 组合。 | ProcessListOptions.filter |
insecure? | boolean | 本次调用 TLS 跳过证书验证选项；仅 Node.js 运行时支持。 | - |
limit? | string | 限制返回列表数量，在排序后、摘取前截断；不改变服务端页大小。 | ProcessListOptions.limit |
pick? | string[] | 摘取字段路径列表。 | ProcessListOptions.pick |
recPerPage? | string | 本次调用使用的每页记录数，优先级高于全局 recPerPage。 | - |
search? | string[] | 模糊搜索关键词组，组内空格分隔为 OR，多组之间按 AND 组合。 | ProcessListOptions.search |
searchFields? | string[] | 限定搜索字段，缺省时搜索全部字段。 | ProcessListOptions.searchFields |
sort? | string | 排序表达式，多个字段以英文逗号分隔，例如 pri:desc,id:asc。 | ProcessListOptions.sort |
throwOnFail? | boolean | 当禅道服务端返回 { status: "fail" } 时是否抛出 E_API_FAILED。 不传时回落到全局 throwOnFail，默认 false（保留原始失败响应）。 | - |
timeout? | number | 本次调用超时时间。 | - |