跳到主要内容

POST 多维表格同步状态

POST 查询。body 为筛选条件 JSON(分页类含 pageNum、pageSize)。

接口编码所需范围后端接口
finance.collection.bitable.sync-statusfinance:readPOST /v1/collection/bitable/sync-status(comap-finance)

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "finance.collection.bitable.sync-status"
}'

响应 data 字段

字段类型必填说明
enabledboolean—当前租户是否已接入该业务多维表格同步(宽松:可见同步按钮、可用筛选同步;不受汇总文档故障影响)
summarySyncEnabledboolean—汇总(全量)同步是否可用(严格:要求汇总文档 ENABLED、汇总表未停发)。
runningboolean—是否有全量同步任务正在运行
taskIdstring—全量同步任务 ID,无任务时为空
totalinteger(int64)—需同步总数
scannedinteger(int64)—已扫描数
sentinteger(int64)—已发送数
statusstring—任务状态:RUNNING / SUCCESS / FAILED
startTimeinteger(int64)—开始时间(毫秒时间戳)
finishTimeinteger(int64)—结束时间(毫秒时间戳)
messagestring—失败信息或备注
modestring—任务模式:FULL=全量 / FILTER=筛选同步(无任务时为空)
docNamestring—筛选同步目标文档名称(仅 FILTER 任务)
appUrlstring—筛选同步目标文档链接(仅 FILTER 任务,完成 toast 直达用)

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 finance:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-finance 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回收款单