简要描述:

  • 审批列表
    获取审批中心中审批列表。

请求URL:

  • http://${host}/api/v1/approval_center/list

请求方式:

  • GET

请求头:

参考新审批说明文档中公共请求头参数

请求参数:

参数名 是否必须 类型 说明
scope string 可取值:todo:我的待办;submission:我的提交;processed:我处理过的。
entity_types string[] 审批对象类型,例如Customer;apaas应用则传递名称如:报价单
submitter_uids int[] 提交人的uid
status string[] 审批状态,可选值描述:applying:审批中;pass:审批通过;veto:审批否决;revocation:审批撤回。

返回示例:

正确时返回:

{
    "code": 0,
    "message": "请求成功",
    "data": {
        "list": [
            {
                "id": 2462,
                "submitter": {
                    "id": 10334573,
                    "uid": 35903635,
                    "name": "John",
                    "third_userid": null
                },
                "submission_time": "2024-04-09 09:56",
                "distance_submission_time": "28 分钟",
                "status": "applying",
                "status_i18n": "待审批",
                "entity_type": "Contract",
                "app": "crm",
                "workflow": {
                    "id": 256,
                    "name": "合同审批"
                },
                "entity_data": {
                    "main_field_value": "审批测试5",
                    "module_label": "合同",
                    "id": 1805501,
                    "body_data": [
                        {
                            "label": "对应客户",
                            "name": "customer",
                            "value": "北京市财政局",
                            "field_type": "select2_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同总金额",
                            "name": "total_amount",
                            "value": "¥ 11.00",
                            "field_type": "currency_field",
                            "is_invisible": false
                        },
                        {
                            "label": "签约日期",
                            "name": "sign_date",
                            "value": "2024-04-09",
                            "field_type": "date_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同类型",
                            "name": "category",
                            "value": null,
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同状态",
                            "name": "status",
                            "value": "未开始",
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "负责人",
                            "name": "user",
                            "value": {
                                "id": 10334573,
                                "uid": 35903635,
                                "name": "John",
                                "third_userid": null
                            },
                            "field_type": "select2_field",
                            "is_invisible": false
                        }
                    ]
                }
            },
            {
                "id": 2461,
                "submitter": {
                    "id": 10334573,
                    "uid": 35903635,
                    "name": "John",
                    "third_userid": null
                },
                "submission_time": "2024-04-09 09:56",
                "distance_submission_time": "28 分钟",
                "status": "applying",
                "status_i18n": "待审批",
                "entity_type": "Contract",
                "app": "crm",
                "workflow": {
                    "id": 256,
                    "name": "合同审批"
                },
                "entity_data": {
                    "main_field_value": "审批测试4",
                    "module_label": "合同",
                    "id": 1901352,
                    "body_data": [
                        {
                            "label": "对应客户",
                            "name": "customer",
                            "value": "北京市财政局",
                            "field_type": "select2_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同总金额",
                            "name": "total_amount",
                            "value": "¥ 22.00",
                            "field_type": "currency_field",
                            "is_invisible": false
                        },
                        {
                            "label": "签约日期",
                            "name": "sign_date",
                            "value": "2024-04-09",
                            "field_type": "date_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同类型",
                            "name": "category",
                            "value": null,
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同状态",
                            "name": "status",
                            "value": "未开始",
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "负责人",
                            "name": "user",
                            "value": {
                                "id": 10334573,
                                "uid": 35903635,
                                "name": "John",
                                "third_userid": null
                            },
                            "field_type": "select2_field",
                            "is_invisible": false
                        }
                    ]
                }
            },
            {
                "id": 2460,
                "submitter": {
                    "id": 10334573,
                    "uid": 35903635,
                    "name": "John",
                    "third_userid": null
                },
                "submission_time": "2024-04-09 09:56",
                "distance_submission_time": "29 分钟",
                "status": "pass",
                "status_i18n": "已通过",
                "entity_type": "Contract",
                "app": "crm",
                "workflow": {
                    "id": 256,
                    "name": "合同审批"
                },
                "entity_data": {
                    "main_field_value": "审批测试3",
                    "module_label": "合同",
                    "id": 1805500,
                    "body_data": [
                        {
                            "label": "对应客户",
                            "name": "customer",
                            "value": "北京市财政局",
                            "field_type": "select2_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同总金额",
                            "name": "total_amount",
                            "value": "¥ 55.00",
                            "field_type": "currency_field",
                            "is_invisible": false
                        },
                        {
                            "label": "签约日期",
                            "name": "sign_date",
                            "value": "2024-04-09",
                            "field_type": "date_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同类型",
                            "name": "category",
                            "value": null,
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同状态",
                            "name": "status",
                            "value": "未开始",
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "负责人",
                            "name": "user",
                            "value": {
                                "id": 10334573,
                                "uid": 35903635,
                                "name": "John",
                                "third_userid": null
                            },
                            "field_type": "select2_field",
                            "is_invisible": false
                        }
                    ]
                }
            },
            {
                "id": 2459,
                "submitter": {
                    "id": 10334573,
                    "uid": 35903635,
                    "name": "John",
                    "third_userid": null
                },
                "submission_time": "2024-04-09 09:36",
                "distance_submission_time": "大约一小时",
                "status": "pass",
                "status_i18n": "已通过",
                "entity_type": "Contract",
                "app": "crm",
                "workflow": {
                    "id": 256,
                    "name": "合同审批"
                },
                "entity_data": {
                    "main_field_value": "测试审批2",
                    "module_label": "合同",
                    "id": 1901351,
                    "body_data": [
                        {
                            "label": "对应客户",
                            "name": "customer",
                            "value": "北京市财政局",
                            "field_type": "select2_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同总金额",
                            "name": "total_amount",
                            "value": "¥ 2,555.00",
                            "field_type": "currency_field",
                            "is_invisible": false
                        },
                        {
                            "label": "签约日期",
                            "name": "sign_date",
                            "value": "2024-04-09",
                            "field_type": "date_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同类型",
                            "name": "category",
                            "value": null,
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同状态",
                            "name": "status",
                            "value": "未开始",
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "负责人",
                            "name": "user",
                            "value": {
                                "id": 10334573,
                                "uid": 35903635,
                                "name": "John",
                                "third_userid": null
                            },
                            "field_type": "select2_field",
                            "is_invisible": false
                        }
                    ]
                }
            },
            {
                "id": 2458,
                "submitter": {
                    "id": 10334573,
                    "uid": 35903635,
                    "name": "John",
                    "third_userid": null
                },
                "submission_time": "2024-04-08 17:19",
                "distance_submission_time": "大约 17 小时",
                "status": "applying",
                "status_i18n": "待审批",
                "entity_type": "Contract",
                "app": "crm",
                "workflow": {
                    "id": 256,
                    "name": "合同审批"
                },
                "entity_data": {
                    "main_field_value": "审批测试1",
                    "module_label": "合同",
                    "id": 1805499,
                    "body_data": [
                        {
                            "label": "对应客户",
                            "name": "customer",
                            "value": "北京市财政局",
                            "field_type": "select2_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同总金额",
                            "name": "total_amount",
                            "value": "¥ 223.00",
                            "field_type": "currency_field",
                            "is_invisible": false
                        },
                        {
                            "label": "签约日期",
                            "name": "sign_date",
                            "value": "2024-04-08",
                            "field_type": "date_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同类型",
                            "name": "category",
                            "value": null,
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "合同状态",
                            "name": "status",
                            "value": "未开始",
                            "field_type": "field_map_field",
                            "is_invisible": false
                        },
                        {
                            "label": "负责人",
                            "name": "user",
                            "value": {
                                "id": 10334573,
                                "uid": 35903635,
                                "name": "John",
                                "third_userid": null
                            },
                            "field_type": "select2_field",
                            "is_invisible": false
                        }
                    ]
                }
            }
        ],
        "total_count": 5,
        "total_pages": 1,
        "has_next_page": false,
        "per_page": 15,
        "page": 1
    }
}

错误时返回:

{
    "errcode": 500,
    "errmsg": "invalid appid"
}

返回参数说明:

参数 类型 描述

submitter

Object 提交人

submission_time

String 提交时间

distance_submission_time

String 提交时间

status

String 审批状态

status_i18n

String 审批状态

workflow

Object 审批触发的流程
entity_type String 审批对象所属模块

entity_data

Object 审批对象相关数据
id Integer 审批对象id
main_field_value String 审批对象主字段的显示值
module_label String 审批对象所属模块显示名
contract_id Integer 审批对象关联合同的id(只有有“对应合同”的才会返回,例如线索没有就不返回)
body_data Object 审批对象展示字段数据
field_type String 字段类型
is_invisible Boolean 是否不可见
label String 字段名称显示值
name String 字段名称
value 字段值(用户部门返回对象,其他直接返回数据值)
multistep_details Array[Object] 我处理tab下返回,返回处理的操作信息
operate_action 审批操作
operate_action_i18n 审批操作显示值
operate_comment 审批操作时的备注
operate_time 审批操作时间

备注:

  • 更多返回错误代码请看首页的错误代码描述
文档更新时间: 2025-04-29 14:18   作者:姜河