飞书 - Data Acquisition

specialRequests 特殊说明

例子一：
官方请求URL为：/open-apis/sheets/v3/spreadsheets/:spreadsheet_token
URL字段应该传递：/open-apis/sheets/v3/spreadsheets/${spreadsheet_token}
specialRequests 字段传递：{"spreadsheet_token":"2222"}

例子二：
官方请求URL为：/open-apis/sheets/v3/:spreadsheets/:spreadsheet_token
URL字段应该传递：/open-apis/sheets/v3/

s p re a d s h ee t s /

{spreadsheet_token}
specialRequests 字段传递：{"spreadsheets":"555,""spreadsheet_token":"2222"}

请求参数

Body 参数application/json

appKey

string

appkey

必需

appSecret

string

appSecret

必需

url

string

请求地址

必需

specialRequests

string

特殊请求，请传递对象，用于url地址中占位符，如url中Hello, ${name}! Your hobby is ${hobby}. 需要传入对象name:1,hobby:2

必需

requestMethod

string

请求方式（大写的GET/POST）

必需

tableName

string

表名

必需

pageNumColum

string

ispage 为 true pageNumColum 不能为空

必需

pageSizeColum

string

ispage 为 true pageNumColum 不能为空

必需

bizParam

string

业务参数

必需

json字符串

isPage

boolean

是否分页

必需

true开启分页，false关闭分页

arrayField

string

数组字段

必需

解析响应数据字段,jsonpath结构

pageRule

number

分页规则

必需

isPage为true生效，默认1； 1 正常分页（分页字段为page页码，，page_size 大小），2游标方式（分页字段 cursor页码游标值，第一次拉取，无需入参，count。页面大小，默认值30，限制1-50）

customKey

string | null

自定义业务参数

可选

json数组结构[{"key":"","value":""}]

isTermination

boolean

异常是否终止

必需

默认为false；true 数据获取出现异常则终止，false 跳过异常继续处理

frequency

number | null

限流

可选

限流，自定义限流时长，如不传递则为600毫秒

database

string

用于确定存储数据库

必需

onlyRead

boolean

只读模式

可选

默认false；开启只读模式后，不会进行数据的写入

validKeys

array[string] | null

自定义取数字段

可选

不传递则为默认取全部，传递后只取该集合下key

示例

{
    "accessToken": "^Yt%Q)",
    "tableName": "Jessica",
    "method": "来意象与备",
    "appKey": "l@O",
    "appSecret": "[UJ",
    "url": "http://brduubqe.zm/mcqblq",
    "bizParam": "[{\"biz\":\"1\"}]",
    "isPage": false,
    "arrayField": "$.data.arrays",
    "pageRule": 1,
    "customKey": "[{\"key\":\"k1\",\"value\":\"v1\"}]",
    "isTermination": true,
    "frequency": 600,
    "database": "xxxxx",
    "onlyRead": false,
    "validKeys": null
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

响应码

必需

message

string

响应信息

必需

data

object

返回数据

必需

requestTotal

integer

请求到总条数

必需

sqlTotal

integer

生成sql总条数

必需

successSqlTotal

integer

成功写入总条数

必需

traceId

string

traceId

必需

示例

成功示例异常示例

{
	"code":0,
	"data":{
		"requestTotal":2423,
		"sqlTotal":1223,
		"successSqlTotal":2423
	},
	"traceId":"171204534693421128f7fa3c940288d8f3ffd5ef128d9"
}