纷享销客开发者手册 纷享销客开发者手册
  • APL开发手册
  • PWC开发手册
  • OpenAPI 文档
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门

  • API授权流程

  • API基础说明

  • OpenAPI

    • CRM对象接口

    • CRM对象通用接口

      • 对象描述接口

      • 审批流程接口

        • 查询审批流定义列表
        • 查询单个审批流任务对象详细信息
        • 终止业务流实例接口
        • 获取对象数据各类业务流程信息
        • 业务流完成/拒绝
        • 触发阶段推进器(非商机2.0)
        • 审批流任务
        • 审批流流程完成
        • 查询对象审批流实例
        • 审批流当前任务驳回到前面的某个节点
        • 完成对象数据发起的任务
        • 查询对象数据的上的流程实例信息
        • 审批流程取消
        • 工作流任务完成
        • 根据条件查询审批流实例数据列表
          • 查询审批流实例详情
          • 审批流查询当前实例可以驳回到哪个节点
          • 获取对象数据的任务详情(包括描述)
          • 通过阶段推进器实例修改阶段推进器阶段
        • 自定义函数接口

        • 解锁锁定接口

        • 相关团队接口

        • 币种相关接口

        • 业务流程接口

        • 阶段推进器接口

        • 产品分类接口

        • 其他通用接口

      • 通讯录接口

      • 其他接口

    • 免登集成方案

    • 客户端开发

    • 常见问题

    目录

    根据条件查询审批流实例数据列表

    # 描述

    根据条件查询审批流实例数据列表

    # 请求说明

    请求方式:POST + application/json

    请求路径:https://${填入所在云的域名}/cgi/crm/v2/data/query?thirdTraceId=${随机字符串}

    请求头填写 :参考公共参数填写

    # 请求参数

    参数 类型 是否必填 说明
    data Map 是 数据map
      dataObjectApiName String 是 对象的api_name,固定取值:ApprovalInstanceObj
      find_explicit_total_num Boolean 否 是否返回总数(true->返回total,false->不返回total总数。默认true。设置为false可以加快接口响应速度)
      search_query_info Map 是 查询条件说明
        limit Int 是 分页条数(最大值为100)
        offset Int 是 偏移量(从0开始、数值必须为limit的整数倍)
        filters List 是 过滤条件列表
          field_name String 是 字段名
          field_values List[String] 是 字段值
          operator String 是 操作符,详细见下方[operator参数说明]
        orders List 是 查询条件
          fieldName String 是 字段名
          isAsc Boolean 是 是否升序(如果是true,按照升序排列,如果是false,则按照倒序排列)
        fieldProjection List[String] 是 返回字段列表,取值对象字段中的apiName

    # operator 参数说明

    可以直接使用对象列表页面中的查询条件,查看如何获取列表中的查询条件

    参数 参数含义 说明 参数 参数含义 说明
    EQ 等于 N 不等于 可以查出空值
    GT 大于 GTE 大于等于
    LT 小于 LTE 小于等于
    LIKE 包含 NLIKE 不包含
    IS 为空 ISN 不为空
    IN 属于 NIN 不属于
    BETWEEN 介于 NBETWEEN 不介于
    STARTWITH 开始于 ENDWITH 结束于
    HASANYOF 有重叠元素 NHASANYOF 没有重叠

    # 请求示例

    {
      "data": {
        "find_explicit_total_num": "",
        "search_query_info": {
          "limit": 5,
          "orders": [
            {
              "fieldName": "payment_amount",
              "isAsc": false
            }
          ],
          "fieldProjection": [
            "_id",
            "name"
          ],
          "filters": {
            "operator": "IN",
            "field_name": "owner",
            "field_values": [
              "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
            ]
          }
        },
        "dataObjectApiName": "ApprovalInstanceObj"
      },
      "offset": 0
    }
    

    # 返回参数

    参数 类型 说明
    traceId string 请求唯一ID
    errorDescription string 错误描述
    data Map 参数详细信息请调用查询对象描述接口
    errorMessage string 错误信息
    errorCode Int 查看错误码

    # 返回示例

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "data": {
        "created_by__r": {},
        "lock_status": "0",
        "is_deleted": false,
        "create_time": 1612247399397,
        "name": "xxxxxx",
        "_id": "69046aexxxxxxx"
      },
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
    • 如果字段的值为空,则不返回这个字段;

    # 特殊说明

    # operator参数说明

    此接口对应的返回值即为对象相关字段,详情见关于审批流实例对象字段的说明 (opens new window)下列参数为本接口特有返回值 返回错误代码请参见。全局返回错误码

    参数 参数含义 参数 参数含义
    EQ = GT >
    LT < GTE >=
    LTE <= N <>
    LIKE LIKE NLIKE NOT LIKE
    IS IS ISN IS NOT
    IN IN NIN NOT IN
    BETWEEN BETWEEN NBETWEEN NOT BETWEEN
    STARTWITH LIKE% ENDWITH %LIKE
    CONTAINS Array 包含
    工作流任务完成
    查询审批流实例详情

    ← 工作流任务完成 查询审批流实例详情 →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式