飞书 API

创建条件格式

POST

/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/condition_formats/batch_create

自建应用商店应用

该接口用于创建新的条件格式，单次最多支持增加10个条件格式，每个条件格式的设置会返回成功或者失败，失败的情况包括各种参数的校验。

错误码

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets//condition_formats/batch_create' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "sheet_condition_formats": [
    {
      "sheet_id": "40a7b0",
      "condition_format": {
        "ranges": [
          "40a7b0!C3:C3"
        ],
        "rule_type": "timePeriod",
        "attrs": [
          {
            "operator": "is",
            "time_period": "today",
            "formula": [],
            "text": ""
          }
        ],
        "style": {
          "font": {
            "bold": true,
            "italic": true
          },
          "fore_color": "#faf1d1",
          "back_color": "#d9f5d6",
          "text_decoration": 3
        }
      }
    }
  ]
}'

响应示例

{
    "code": 0,
    "msg": "Success",
    "data": {
        "responses": [
            {
                "cf_id": "1gJelvenW9",
                "res_code": 0,
                "res_msg": "success",
                "sheet_id": "40a7b0"
            }
        ]
    }
}

请求参数

Path 参数

spreadsheetToken

string

必需

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

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

Body 参数application/json

sheet_condition_formats

array [object {2}]

表格的条件格式信息

必需

sheet_id

string

sheet的id

必需

condition_format

object

必需

一个条件格式的详细信息

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

responses

array [object {4}]

响应

必需

修改于 2023-01-18 06:36:51

条件格式指南

获取条件格式

创建条件格式

错误码#

请求参数

返回响应

错误码