纷享销客开发者手册 纷享销客开发者手册
  • 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对象通用接口

    • 通讯录接口

    • 其他接口

      • 任务待办接口

      • 考勤外勤接口

      • 协同审批接口

      • 企业互联接口

      • 消息接口

      • 素材管理接口

      • 网盘接口

      • 营销通接口

      • 文件服务

      • ERP接口

      • BI接口

      • 下线接口

        • 设置成员状态(批量)
        • 修改部门
        • 根据时间段分页查询修改的员工列表
        • 设置成员状态
        • 获取部门详情
        • 根据openUserId查询员工信息
        • 设置部门状态
        • 修改成员
        • 获取部门列表
        • 根据手机号查询员工
        • 创建预设对象
        • 删除预设对象
        • 查询预设对象详情
        • 作废预设对象
        • 查询预设对象列表
        • 修改预设对象
        • 恢复预设对象
        • 变更预设对象负责人
        • 创建Erp对象
        • 查询Erp对象列表
          • 查询Erp对象详情
          • 修改Erp对象
          • 恢复Erp对象
          • 作废Erp对象
          • 变更Erp对象负责人
          • 删除Erp对象
    • 免登集成方案

    • 客户端开发

    • 常见问题

    目录

    查询Erp对象列表

    # 不建议继续使用下线接口!!!

    # 描述

    查询Erp对象列表

    # 请求说明

    请求方式:POST + application/json

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

    # 请求参数

    参数 参数类型 必须 备注
    corpAccessToken String 是 企业应用访问公司合法性凭证
    corpId String 是 企业ID
    currentOpenUserId String 是 当前操作人OpenUserID
    data 二级对象 是 查询条件
    data.dataObjectApiName String 是 对象的api_name
    data.search_query_info 三级对象 是 查询条件列表
    data.search_query_info.limit int 是 获取数据条数, 最大值为100
    data.search_query_info.offset int 是 偏移量,从0开始、数值必须为limit的整数倍
    data.search_query_info.filters List 是 过滤条件列表
    data.search_query_info.filters.field_name String 是 字段名
    data.search_query_info.filters.field_values List 是 取值范围
    data.search_query_info.filters.operator String 是 支持操作
    data.search_query_info.orders List 是 排序
    data.search_query_info.orders.fieldName String 是 字段名
    data.search_query_info.orders.isAsc boolean 是 如果是true,按照升序排列,如果是false,则按照倒序排列
    data.search_query_info.fieldProjection List 否 返回字段列表
    data.find_explicit_total_num Boolean 否 true->返回total,false->不返回total总数。默认true。设置为false可以加快接口响应速度

    # operator参数说明

    参数 参数含义 参数 参数含义
    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 包含

    # 请求示例

    {
        "corpAccessToken": "98747229F3B372F9F2120789FC55ED6F",
        "corpId": "FSCID_902A6E6771D07046EB44E20025355DDB",
        "currentOpenUserId": "FSUID_C6384C8A5942F92C691BC1339D367877",
        "data": {
            "dataObjectApiName": "ErpStockObj",
            "search_query_info": {
                "offset": 0,
                "limit": 100,
                "filters": [
                    {
                        "field_name": "owner",
                        "field_values": [
                            "FSUID_C6384C8A5942F92C691BC1339D367877"
                        ],
                        "operator": "EQ"
                    }
                ],
                "orders": [
                    {
                        "fieldName": "last_modified_time",
                        "isAsc": true
                    }
                ]
            }
        }
    }
    

    # 返回参数

    参数 必须 说明
    data 是 查询结果
    data.total 是 实际总记录数
    data.offset 是 偏移量
    data.limit 是 查询数据的条数
    data.dataList 是 数据列表
    errorCode 是 返回码
    errorMessage 是 对返回码的文本描述内容
    errorDescription 是 对返回码的文本描述内容

    注意:当字段是关联字段类型时,关联对象的主属性名称字段未:{关联字段ApiName}__r,例如,对象中的关联字段:account_id,它对应的关联对象的主属性字段为:account_id__r

    # 返回示例

    {
        "data": {
            "total": 4,
            "offset": 0,
            "dataList": [
                {
                    "payment_time": 1517328000000,
                    "remark": "测试更新02",
                    "account_id__r": "测试",
                    "is_deleted": false,
                    "attachment": [],
                    "order_data_id": "974789b4d13040fcbb9d0ae35cxxxxxx",
                    "total_num": 4,
                    "owner_department": "董事会",
                    "owner": [
                       "FSUID_0253C6D7FC0E3A2CBB19F336CEXXXXXX"
                    ],
                    "lock_status": "0",
                    "last_modified_time": 1519986766107,
                    "create_time": 1519985373616,
                    "payment_term": "2",
                    "life_status": "normal",
                    "payment_amount": "300.00",
                    "last_modified_by": [
                       "FSUID_0253C6D7FC0E3A2CBB19F336CEXXXXXX"
                     ],
                    "created_by": [
                       "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
                    ],
                    "record_type": "default__c",
                    "notification_time": 1517241600000,
                    "account_id": "2d58af2dbb4d4ecd931e80ef18xxxxxx",
                    "name": "20180302-000004",
                    "_id": "5a9922dd742c2ff572xxxxxx",
                    "order_id": "20180302-000002"
                },
                {
                    "payment_time": 1521561600000,
                    "account_id__r": "测试",
                    "is_deleted": true,
                    "attachment": [],
                    "order_data_id": "974789b4d13040fcbb9d0ae35cxxxxxx,cff4ca67f38c49639df64f50d3xxxxxx",
                    "total_num": 4,
                    "owner_department": "董事会",
                    "owner": [
                       "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
                    ],
                    "lock_status": "0",
                    "last_modified_time": 1519984004508,
                    "create_time": 1519978401106,
                    "life_status": "invalid",
                    "payment_amount": "20.00",
                    "last_modified_by": [
                       "FSUID_0253C6D7FC0E3A2CBB19F336CEXXXXXX"
                    ],
                    "created_by": [
                       "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
                    ],
                    "record_type": "default__c",
                    "account_id": "2d58af2dbb4d4ecd931e80ef18xxxxxx",
                    "name": "20180302-000002",
                    "_id": "5a9907a1f125ae0a1axxxxxx",
                    "order_id": "20180302-000002,20180302-000001"
                }
            ],
            "limit": 5
        },
        "errorCode": 0,
        "errorMessage": "OK",
        "errorDescription": "success"
    }
    

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
    创建Erp对象
    查询Erp对象详情

    ← 创建Erp对象 查询Erp对象详情 →

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