飞书 API

获取保护范围

GET

/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/protected_range_batch_get

自建应用商店应用

该接口用于根据保护范围ID查询详细的保护行列信息，最多支持同时查询5个ID。

错误码

具体可参考：服务端错误码说明

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets//protected_range_batch_get?protectIds' \
--header 'Authorization;'

响应示例

{
  "code": 0,
  "msg": "Success",
  "data": {
    "protectedRanges": [
      {
        "protectId": "*****",
        "dimension": {
          "sheetId": "***",
          "startIndex": 0,
          "endIndex": 0,
          "majorDimension": "COLUMNS"
        },
        "editors": {
          "users": [
            {
              "memberType": "userId",
              "memberId": "***"
            }
          ]
        },
        "sheetId": "***"
      }
    ]
  }
}

请求参数

Path 参数

spreadsheetToken

string

必需

spreadsheet 的 token，获取方式见在线表格开发指南

Query 参数

protectIds

string

必需

保护范围ID，可以通过获取表格元数据接口获取，多个ID用逗号分隔，如xxxID1,xxxID2

memberType

string

可选

返回的用户类型，可选userId,openId,unionId,默认使用userId

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

protectedRanges

array [object {4}]

保护范围

必需

修改于 2023-01-18 06:27:20

增加保护范围

修改保护范围

获取保护范围

错误码#

请求参数

返回响应

错误码