GET 分页查询服务工单
GET 分页查询售后服务工单。query 参数:current(页码,默认1)、size(每页条数,默认20);可选 search(模糊匹配工单号/客户名称/SN/型号/联系人)、type(工单类型名称)、status(工单状态,如 待提交/待受理/待分派/待接单/服务中/待协同/已挂起/已完工/待回访/已关闭/已驳回)、urgency(紧急/高/中/低)、view(快捷视图 all/my/accept/dispatch/take/appointment/processing/confirm/follow-up/overtime/chargeable)、customerId、salesOrderId、contractId、projectId、sortField、sortOrder(asc/desc)。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.service-order.page | sales:read | GET /v1/service-orders/page(comap-sales) |
请求参数(query)
本接口的 query 参数由后端查询对象整体展开,接口规格未保留各字段的原始 类型,故类型列统一显示为
string。实际取值语义见「说明」列,按自然类型 传即可(如"pageNum": 1),服务端会完成转换。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
current | string | — | 页码,从 1 开始 |
size | string | — | 每页条数 |
search | string | — | 关键字,模糊匹配 工单号/客户名称/SN/型号/联系人 |
type | string | — | 工单类型,取值来自 t_service_order_type.name |
status | string | — | 工单状态 |
urgency | string | — | 紧急程度:紧急/高/中/低 |
view | string | — | 快捷视图码:all/my/accept/dispatch/take/appointment/processing/confirm/follow-up/overtime/chargeable;与前端 QUICK_VIEW_QUERY 一致。也兼容传中文标签,但不推荐 |
customerId | string | — | 服务客户ID;兼容历史 customer_id 与二期 service_customer_id |
salesOrderId | string | — | 关联销售订单ID;兼容历史 sales_order_id 与统一主要来源 |
contractId | string | — | 关联合同ID;兼容销售合同、服务合同与历史 contract_id |
projectId | string | — | 关联项目ID;兼容历史 project_id 与统一主要来源 |
sortField | string | — | 列表排序字段:orderNo/title/type/customerName/assignee/urgency/createTime/planStart/responseMins,默认 createTime;不在白名单内的值按默认处理 |
sortOrder | string | — | 列表排序方向:asc / desc,默认 desc |
advancedFilters | string | — | 高级筛选条件(JSON字符串),如 {"customerName":{"op":"contains","value":"英特"}} |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.service-order.page",
"query": {
"current": 1,
"size": 10
}
}'
响应 data 字段(分页结构:records[] + total)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
size | integer(int64) | — | — |
records46 | ServiceOrderVO[] | — | — |
total | integer(int64) | — | — |
current | integer(int64) | — | — |
pages | integer(int64) | — | — |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回服务工单