跳到主要内容

GET 分页查询框架协议

GET 分页查询。query 参数:pageNum、pageSize、keyword(协议编号/客户名称)、tabFilter(ALL/PENDING 待审批/ACTIVE 生效中/EXPIRED 已过期/TERMINATED 已终止)、status(0草稿 1待审批 2已审批 3已驳回 4已取消)。

接口编码所需范围后端接口
sales.framework-agreement.pagesales:readGET /v1/sales/framework-agreement/page(comap-sales)

请求参数(query)

本接口的 query 参数由后端查询对象整体展开,接口规格未保留各字段的原始 类型,故类型列统一显示为 string。实际取值语义见「说明」列,按自然类型 传即可(如 "pageNum": 1),服务端会完成转换。

字段类型必填说明
keywordstring—关键词(协议编号/客户名称)
tabFilterstring—Tab 筛选:ALL(或不传)、PENDING(待审批)、ACTIVE(生效中)、EXPIRED(已过期)、TERMINATED(已终止)。 与 {@link
statusstring—状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
pageNumstring—页码,从 1 开始
pageSizestring—每页返回的数量

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.framework-agreement.page",
"query": {
"pageNum": 1,
"pageSize": 10
}
}'

响应 data 字段(分页结构:records[] + total)

字段类型必填说明
sizeinteger(int64)——
records13FrameworkAgreementVO[]——
totalinteger(int64)——
currentinteger(int64)——
pagesinteger(int64)——

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 sales:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回framework-agreement