zentao-api / request
Function: request()
Call Signature
request(
name,params,options):Promise<unknown>
按模块名或模块动作名请求禅道 API。
选项优先级为：本次调用 options > 全局 options > 客户端默认值。 动作的 beforeRequest 在参数解析后、请求体准备前执行，返回值浅合并到解析后的请求描述中。 当响应 status 为 "fail" 时，默认按原样返回；若 options.throwOnFail 或全局 throwOnFail 为真，则改为抛出 E_API_FAILED。 请求前按 Action 的 minVersion 检查服务器版本；全局 version 可避免配置探测， forceRefreshConfig 则强制使用实际版本。无法获取配置时默认抛错， skipVersionCheckOnConfigError 可允许本次跳过检查，但不能忽略明确的版本不匹配。
对 update 动作，当 options.autoFill 或全局 autoFill 为真时，会先 GET 当前对象， 用现值补齐用户未显式传入的 body 字段后再 PUT，避免禅道覆盖未提交字段。详见 RequestOptions.autoFill。
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | 请求名，例如 product、product/list 或 product/1。 |
params | Record<string, unknown> | undefined | 请求参数。 |
options | RequestOptions & object | 请求选项。 |
Returns
Promise<unknown>
默认返回归一化后的禅道 API 响应；options.raw 为 true 时返回未经归一化的原始响应。
Throws
传输层错误、参数缺失或 throwOnFail 启用时的业务失败。
Call Signature
request<
Name>(name,params?,options?):Promise<ResponseData<RequestResultFor<Name>>>
按模块名或模块动作名请求禅道 API。
选项优先级为：本次调用 options > 全局 options > 客户端默认值。 动作的 beforeRequest 在参数解析后、请求体准备前执行，返回值浅合并到解析后的请求描述中。 当响应 status 为 "fail" 时，默认按原样返回；若 options.throwOnFail 或全局 throwOnFail 为真，则改为抛出 E_API_FAILED。 请求前按 Action 的 minVersion 检查服务器版本；全局 version 可避免配置探测， forceRefreshConfig 则强制使用实际版本。无法获取配置时默认抛错， skipVersionCheckOnConfigError 可允许本次跳过检查，但不能忽略明确的版本不匹配。
对 update 动作，当 options.autoFill 或全局 autoFill 为真时，会先 GET 当前对象， 用现值补齐用户未显式传入的 body 字段后再 PUT，避免禅道覆盖未提交字段。详见 RequestOptions.autoFill。
Type Parameters
| Type Parameter |
|---|
Name extends BuiltinRequestName |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | Name | 请求名，例如 product、product/list 或 product/1。 |
params? | RequestParamsFor<Name> | 请求参数。 |
options? | RequestOptions & object | 请求选项。 |
Returns
Promise<ResponseData<RequestResultFor<Name>>>
默认返回归一化后的禅道 API 响应；options.raw 为 true 时返回未经归一化的原始响应。
Throws
传输层错误、参数缺失或 throwOnFail 启用时的业务失败。
Call Signature
request<
T>(name,params?,options?):Promise<ResponseData<T>>
按模块名或模块动作名请求禅道 API。
选项优先级为：本次调用 options > 全局 options > 客户端默认值。 动作的 beforeRequest 在参数解析后、请求体准备前执行，返回值浅合并到解析后的请求描述中。 当响应 status 为 "fail" 时，默认按原样返回；若 options.throwOnFail 或全局 throwOnFail 为真，则改为抛出 E_API_FAILED。 请求前按 Action 的 minVersion 检查服务器版本；全局 version 可避免配置探测， forceRefreshConfig 则强制使用实际版本。无法获取配置时默认抛错， skipVersionCheckOnConfigError 可允许本次跳过检查，但不能忽略明确的版本不匹配。
对 update 动作，当 options.autoFill 或全局 autoFill 为真时，会先 GET 当前对象， 用现值补齐用户未显式传入的 body 字段后再 PUT，避免禅道覆盖未提交字段。详见 RequestOptions.autoFill。
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
T | unknown | 归一化响应中期望的 data 字段类型；不传时为 unknown，调用方需要自行收窄。 |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | 请求名，例如 product、product/list 或 product/1。 |
params? | Record<string, unknown> | 请求参数。 |
options? | RequestOptions & object | 请求选项。 |
Returns
Promise<ResponseData<T>>
默认返回归一化后的禅道 API 响应；options.raw 为 true 时返回未经归一化的原始响应。
Throws
传输层错误、参数缺失或 throwOnFail 启用时的业务失败。
Call Signature
request(
name,params?,options?):Promise<unknown>
按模块名或模块动作名请求禅道 API。
选项优先级为：本次调用 options > 全局 options > 客户端默认值。 动作的 beforeRequest 在参数解析后、请求体准备前执行，返回值浅合并到解析后的请求描述中。 当响应 status 为 "fail" 时，默认按原样返回；若 options.throwOnFail 或全局 throwOnFail 为真，则改为抛出 E_API_FAILED。 请求前按 Action 的 minVersion 检查服务器版本；全局 version 可避免配置探测， forceRefreshConfig 则强制使用实际版本。无法获取配置时默认抛错， skipVersionCheckOnConfigError 可允许本次跳过检查，但不能忽略明确的版本不匹配。
对 update 动作，当 options.autoFill 或全局 autoFill 为真时，会先 GET 当前对象， 用现值补齐用户未显式传入的 body 字段后再 PUT，避免禅道覆盖未提交字段。详见 RequestOptions.autoFill。
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | 请求名，例如 product、product/list 或 product/1。 |
params? | Record<string, unknown> | 请求参数。 |
options? | RequestOptions | 请求选项。 |
Returns
Promise<unknown>
默认返回归一化后的禅道 API 响应；options.raw 为 true 时返回未经归一化的原始响应。
Throws
传输层错误、参数缺失或 throwOnFail 启用时的业务失败。