类 ListAppTableRecordReq.Builder

java.lang.Object
com.lark.oapi.service.bitable.v1.model.ListAppTableRecordReq.Builder
封闭类:
ListAppTableRecordReq

public static class ListAppTableRecordReq.Builder extends Object
  • 构造器详细资料

    • Builder

      public Builder()
  • 方法详细资料

    • viewId

      public ListAppTableRecordReq.Builder viewId(String viewId)
      视图的唯一标识符,获取指定视图下的记录[view_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe);;注意:;当 filter 参数 或 sort 参数不为空时,请求视为对数据表中的全部数据做条件过滤,指定的view_id 会被忽略。

      示例值:vewqhz51lk

      参数:
      viewId -
      返回:
    • filter

      public ListAppTableRecordReq.Builder filter(String filter)
      筛选参数,用于指定本次查询的筛选条件;;注意:;;1.不支持对“人员”以及“关联字段”的属性进行过滤筛选,如人员的 OpenID。;;2.指定筛选条件时,参数长度不超过2000个字符。;;;详细请参考[筛选条件支持的公式](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter)

      示例值:AND(CurrentValue.[身高]>180, CurrentValue.[体重]>150)

      参数:
      filter -
      返回:
    • sort

      排序参数,用于指定本次查询返回结果的顺序;;注意:;;1.不支持对带“公式”和“关联字段”的表的使用。;;2.指定排序条件时,参数长度不超过1000字符。;;3.当存在多个排序条件时,数据将根据条件顺序逐层排序

      示例值:["字段1 DESC","字段2 ASC"]

      参数:
      sort -
      返回:
    • fieldNames

      public ListAppTableRecordReq.Builder fieldNames(String fieldNames)
      字段名称,用于指定本次查询返回记录中包含的字段

      示例值:["字段1","字段2"]

      参数:
      fieldNames -
      返回:
    • textFieldAsArray

      public ListAppTableRecordReq.Builder textFieldAsArray(Boolean textFieldAsArray)
      控制多行文本字段数据的返回格式,true 表示以数组形式返回。;;注意:;;1.多行文本中如果有超链接部分,则会返回链接的 URL。;;2.目前可以返回多行文本中 URL 类型为多维表格链接、飞书 doc、飞书 sheet的URL类型以及@人员的数据结构。

      示例值:true

      参数:
      textFieldAsArray -
      返回:
    • userIdType

      public ListAppTableRecordReq.Builder userIdType(String userIdType)
      此次调用中使用的用户ID的类型

      示例值:

      参数:
      userIdType -
      返回:
    • userIdType

      此次调用中使用的用户ID的类型

      示例值:

      参数:
      userIdType - ListAppTableRecordUserIdTypeEnum
      返回:
    • displayFormulaRef

      public ListAppTableRecordReq.Builder displayFormulaRef(Boolean displayFormulaRef)
      默认值为false,返回当前字段的默认类型和结果;当该参数的值为true时,公式 和 查找引用 类型的字段,将会以 被引用字段 的格式返回

      示例值:true

      参数:
      displayFormulaRef -
      返回:
    • automaticFields

      public ListAppTableRecordReq.Builder automaticFields(Boolean automaticFields)
      控制是否返回自动计算的字段,例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`,true 表示返回

      示例值:true

      参数:
      automaticFields -
      返回:
    • pageToken

      public ListAppTableRecordReq.Builder pageToken(String pageToken)
      分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该page_token 获取查询结果

      示例值:recn0hoyXL

      参数:
      pageToken -
      返回:
    • pageSize

      public ListAppTableRecordReq.Builder pageSize(Integer pageSize)
      分页大小

      示例值:10

      参数:
      pageSize -
      返回:
    • appToken

      public ListAppTableRecordReq.Builder appToken(String appToken)
      多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe)

      示例值:bascnCMII2ORej2RItqpZZUNMIe

      参数:
      appToken -
      返回:
    • tableId

      public ListAppTableRecordReq.Builder tableId(String tableId)
      多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883)

      示例值:tblxI2tWaxP5dG7p

      参数:
      tableId -
      返回:
    • build

      public ListAppTableRecordReq build()