中科图灵开放平台 / 智慧消防系统管理模块 / 流程预案-查询流程预案列表

流程预案-查询流程预案列表

接口描述: 流程预案-查询流程预案列表

HTTP/HTTPS
请求协议
GET
请求方式
UTF-8
编码格式
JSON
返回格式
v1.0
版本号

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
apiRequestRaw字符串必须-{ "flowPlanCode":"defect_treatment", //流程预案code "groupCode":"defect_treatment_02", //流程用户组code "deptId":14, //右侧选中的一般单位id "userIds":"12,13,14" //用户id的列表,多个以逗号隔开 }
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.data数组
data.data>>id字符串流程预案id
data.data>>code字符串流程预案code
data.data>>name字符串流程预案名称
data.data>>createTime字符串创建时间
data.data>>groupList数组用户组列表
data.data>>groupList>>id字符串组id
data.data>>groupList>>flowPlanId字符串流程预案id
data.data>>groupList>>groupCode字符串组code
data.data>>groupList>>groupName字符串组名称
data.data>>groupList>>userIds字符串用户id列表,多个以逗号隔开
data.data>>groupList>>deptId字符串单位id
data.data>>groupList>>tenantId字符串站点id
data.data>>groupList>>userNames字符串用户名称列表,多个以逗号隔开
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
apiRequestRaw 必须
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": [
        {
            "id": 1,
            "code": "disaster_relief",
            "name": "灾情救援",
            "createTime": "2020-06-22 20:27:41",
            "groupList": [
                {
                    "id": 1,
                    "flowPlanId": 1,
                    "groupCode": "disaster_relief_01 ",
                    "groupName": "现场核实组",
                    "userIds": "12,13,14",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四,王五,陈六"
                },
                {
                    "id": 2,
                    "flowPlanId": 1,
                    "groupCode": "disaster_relief_02",
                    "groupName": "疏散引导组",
                    "userIds": "12,13,14",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四,王五,陈六"
                },
                {
                    "id": 3,
                    "flowPlanId": 1,
                    "groupCode": "disaster_relief_03",
                    "groupName": "灭火行动组",
                    "userIds": "12,13,14",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四,王五,陈六"
                },
                {
                    "id": 4,
                    "flowPlanId": 1,
                    "groupCode": "disaster_relief_04",
                    "groupName": "物资抢救组",
                    "userIds": "12,13,14",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四,王五,陈六"
                },
                {
                    "id": 5,
                    "flowPlanId": 1,
                    "groupCode": "disaster_relief_05",
                    "groupName": "现场警戒组",
                    "userIds": "12,13,14",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四,王五,陈六"
                },
                {
                    "id": 6,
                    "flowPlanId": 1,
                    "groupCode": "disaster_relief_06",
                    "groupName": "总负责人",
                    "userIds": "12",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四"
                }
            ]
        },
        {
            "id": 2,
            "code": "defect_treatment",
            "name": "隐患处理",
            "createTime": "2020-06-22 20:32:45",
            "groupList": [
                {
                    "id": 7,
                    "flowPlanId": 2,
                    "groupCode": "defect_treatment_01",
                    "groupName": "隐患上报",
                    "userIds": "12,13,14",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四,王五,陈六"
                },
                {
                    "id": 8,
                    "flowPlanId": 2,
                    "groupCode": "defect_treatment_02",
                    "groupName": "隐患审核",
                    "userIds": "12,13,14",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四,王五,陈六"
                },
                {
                    "id": 9,
                    "flowPlanId": 2,
                    "groupCode": "defect_treatment_03",
                    "groupName": "处理工单",
                    "userIds": "12,13,14",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四,王五,陈六"
                },
                {
                    "id": 10,
                    "flowPlanId": 2,
                    "groupCode": "defect_treatment_04",
                    "groupName": "工单审核",
                    "userIds": "12",
                    "deptId": 14,
                    "tenantId": 1,
                    "userNames": "李四"
                }
            ]
        }
    ]
}
失败响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": null
}

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
409ret=409,接口流量不足
500表示服务端内部错误

本文档生成时间:2024-03-29 03:53:42