更新时间:2021-12-27 GMT+08:00
分享

公共数据结构

列表查询参数(queryOption)

参数

是否必选

类型

说明

offset

Integer

查询的开始位置,取值范围为1~100000,必须与limit一起使用。

与limit同时缺省时,返回所有结果。该参数适用于所有查询列表的接口。

如果offset超过数据总条数,则结果返回空列表。

limit

Integer

返回结果的最大条目数,取值范围为1~1000,必须与offset一起使用。

与offset同时缺省时,返回所有结果。该参数适用于所有查询列表的接口。

sort

String

返回结果的排序规则:
  • ASC:表示升序。
  • DESC:表示降序。

默认为ASC,需要有offset和limit参数,sort参数才会生效。

order_by

String

选择按一个字段进行排序,默认按照创建时间(created_at)排序。

需要有offset和limit参数,order_by参数才会生效。

分页响应参数(pagination)

分页响应参数,当有offset与limit查询参数时,返回如下结构:

参数

类型

说明

total

Integer

总条目数。

entries

Array of entries objects

该页的数据列表。

相关文档