业务数据

接口说明

该接口用于批量获取业务数据,每次调用返回最多1000条数据,按version,id升序排序

接口地址

/v3/biz-data

接口类型

Http

请求方式

POST

内容类型

application/json

鉴权策略

参见《Open-API鉴权协议》

请求参数

请求头

body参数内容

{
  "tableName": "unitWork",                        // 表名
  "attributes": ["id","orgId","name","version"],  // 字段属性列表,可为空
  "orgId": 863807599308800,                       // 机构Id
  "lastMaxVersion": 0,                            // 上次获取数据中的最大版本号
  "lastMaxId": 0,                                 // 上次获取数据中的最大Id
}

body参数说明

参数名称 数据类型 是否必填 说明
tableName string 指定查询的表名称,不能为空
attributes array 查询字段,不传则查询表所有字段
orgId int 机构Id
lastMaxVersion int 上次获取数据中的最大版本号
lastMaxId int 上次拉取数据中的最大Id

其他说明

  • 每次调用会返回version>lastMaxVersion,或者version=lastMaxVersion并且id>lastMaxId的按version,id升序排序的最多1000条数据,在循环调用过程中,如果发现返回的数据条数不足1000,应该跳出循环。
  • 获取lastMaxVersion和lastMaxId时,应该限定为当前orgId对应的机构,如果没有限定机构,有可能会漏数据。

响应报文

[
   {
        "id": 504981179674624,
        "orgId": 863807599308800,
        "name": "名称1",
        "version": 504981179674620
    },
    {
        "id": 536183065219584,
        "orgId": 863807599308800,
        "name": "名称2",
        "version": 504981179674621
    }
]

响应状态码

字段名称 数据类型
200 成功
400 用户请求头中Authorization值的格式不对,错误码:InvalidArgument。
403 AccessId不存在或被禁用 错误码:InvalidAccessId
500 非法参数或接口执行异常

响应数据结构

表名及字段说明

Copyright © 北京梦诚科技有限公司 2020 all right reserved,powered by Gitbook该文件修订时间: 2022-08-25 11:05:18

results matching ""

    No results matching ""