跳转至

apps

feishu.bitable.apps

AppsNamespace

Bases: Namespace

多维表格应用(app)接口命名空间。

通过 client.bitable.apps 访问,封装多维表格应用相关的服务端接口,目前提供应用元数据的查询。 多维表格以应用为容器,应用内含若干数据表,常以 app_token 标识。

通常无需直接实例化,应通过 client.bitable.apps 访问。

飞书文档

多维表格概述

源代码位于: feishu/bitable/apps.py
Python
class AppsNamespace(Namespace):
    r"""
    多维表格应用(app)接口命名空间。

    通过 `client.bitable.apps` 访问,封装多维表格应用相关的服务端接口,目前提供应用元数据的查询。
    多维表格以应用为容器,应用内含若干数据表,常以 `app_token` 标识。

    通常无需直接实例化,应通过 `client.bitable.apps` 访问。

    飞书文档:
        [多维表格概述](https://open.feishu.cn/document/server-docs/docs/bitable-v1/bitable-overview)
    """

    async def get(self, app_token: str) -> NestedDict:
        r"""
        获取多维表格元数据。

        Args:
            app_token: 多维表格的唯一标识 `app_token`。

        Returns:
            包含 `app` 字段的数据,`app` 内含 `app_token`、`name`、`revision`、`is_advanced`
            等字段。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [获取多维表格元数据](https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/get)

        Examples:
            >>> await client.bitable.apps.get("bascnxxx")  # doctest:+SKIP
            {'app': {'app_token': 'bascnxxx', 'name': 'My Base', 'revision': 12, ...}}  # noqa: E501
        """
        return await self._request_data("GET", f"bitable/v1/apps/{quote_segment(app_token)}")

get async

Python
get(app_token: str) -> NestedDict

获取多维表格元数据。

参数:

名称 类型 描述 默认
app_token
str

多维表格的唯一标识 app_token

必需

返回:

类型 描述
NestedDict

包含 app 字段的数据,app 内含 app_tokennamerevisionis_advanced

NestedDict

等字段。

引发:

类型 描述
FeishuError

请求失败或返回错误码时抛出。

飞书文档

获取多维表格元数据

示例:

Python Console Session
>>> await client.bitable.apps.get("bascnxxx")
{'app': {'app_token': 'bascnxxx', 'name': 'My Base', 'revision': 12, ...}}  # noqa: E501
源代码位于: feishu/bitable/apps.py
Python
async def get(self, app_token: str) -> NestedDict:
    r"""
    获取多维表格元数据。

    Args:
        app_token: 多维表格的唯一标识 `app_token`。

    Returns:
        包含 `app` 字段的数据,`app` 内含 `app_token`、`name`、`revision`、`is_advanced`
        等字段。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [获取多维表格元数据](https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/get)

    Examples:
        >>> await client.bitable.apps.get("bascnxxx")  # doctest:+SKIP
        {'app': {'app_token': 'bascnxxx', 'name': 'My Base', 'revision': 12, ...}}  # noqa: E501
    """
    return await self._request_data("GET", f"bitable/v1/apps/{quote_segment(app_token)}")