---
schema_version: "1"
id: 1bf21ce10716459ff6a4ffce7aeca55d2a40576d59972e02122cc442d4fb6245
title: 实体快照参考
collection: tableau
version: current
locale: zh-cn
portal_url: https://docs.salesforce.com/tableau/current/zh-cn/online/activity_log_entity_snapshots_reference.md
canonical_url: https://help.tableau.com/current/online/zh-cn/activity_log_entity_snapshots_reference.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 2f70fc39aeed703af7f64f1fba374deeb75c7b2d28f5716c1707b6bcc1c958bb
description: 本主题介绍通过 Tableau Cloud Manager REST API 提供的实体快照表和字段。有关实体快照的详细信息，请参见使用实体快照和平台数据。
---
[跳转到主要内容](#main-content)

# 实体快照参考

本主题介绍通过 Tableau Cloud Manager REST API 提供的实体快照表和字段。有关实体快照的详细信息，请参见[使用实体快照](https://help.tableau.com/current/online/zh-cn/activity_log_entity_snapshots.htm)和[平台数据](https://help.tableau.com/current/api/cloud-manager/zh-cn/docs/platform_data.html)。

## 实体快照表

使用右侧按字母顺序排列的实体表列表，或使用 **ctrl/cmd-f** 直接转到您想到的关键字。

**注意：**时间戳以 ISO 8601 UTC 格式记录。

## 能力

`capabilities` 实体类型包含有关权限可授予或拒绝的能力的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>description</td><td>字符串</td><td>对能力允许用户执行的操作的描述。</td></tr><tr><td>display_name</td><td>字符串</td><td>向用户显示的能力的名称。</td></tr><tr><td>display_order</td><td>整数</td><td>能力在界面中列出的顺序。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>name</td><td>字符串</td><td>用于在代码中引用能力的名称或 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr></tbody></table>

## data\_connections

`data_connections` 实体类型包含有关工作簿和数据源使用的连接的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>authentication</td><td>字符串</td><td>用于数据连接的身份验证方法。</td></tr><tr><td>caption</td><td>字符串</td><td>显示在“数据”窗格中的连接的名称。</td></tr><tr><td>cloud_file_request_url</td><td>字符串</td><td>与数据连接关联的云文件的请求 URL。此值可以为 null。</td></tr><tr><td>created_at</td><td>时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>datasource_id</td><td>整数</td><td>拥有此数据连接的数据源的 ID。</td></tr><tr><td>db_subclass</td><td>字符串</td><td>数据库类的子类。例如，如果数据库类为 web-data-direct，则子类为 intuit-quickbook。</td></tr><tr><td>dbclass</td><td>字符串</td><td>数据连接的类型，例如 MySQL、PostgreSQL 或 SQL 代理。</td></tr><tr><td>dbname</td><td>字符串</td><td>此连接的数据库的名称。</td></tr><tr><td>has_extract</td><td>布尔值</td><td>指明数据连接是否为数据提取。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>keychain</td><td>字符串</td><td>YAML 格式的编码字符串。</td></tr><tr><td>luid</td><td>uuid</td><td>用于在 Tableau REST API 中标识连接的唯一标识符。Tableau 自动生成此值。</td></tr><tr><td>name</td><td>字符串</td><td>数据连接的唯一名称。</td></tr><tr><td>owner_id</td><td>整数</td><td>创建数据连接的工作簿或数据源的 ID。</td></tr><tr><td>owner_type</td><td>字符串</td><td>创建数据连接的内容类型。工作簿或数据源。</td></tr><tr><td>password</td><td>布尔值</td><td>指示密码是否嵌入在所有者中。</td></tr><tr><td>port</td><td>整数</td><td>连接的端口号。</td></tr><tr><td>query_tagging_enabled</td><td>布尔值</td><td>指示针对此数据连接的查询是否使用有关其在 Tableau 中的来源的信息进行标记。</td></tr><tr><td>server</td><td>字符串</td><td>用于连接的服务器的名称。</td></tr><tr><td>site_id</td><td>整数</td><td>数据连接所在站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>state</td><td>字符串</td><td>发布状态。active 或 archived。</td></tr><tr><td>tablename</td><td>字符串</td><td>用于连接的数据库表的名称。</td></tr><tr><td>updated_at</td><td>时间戳</td><td>记录的上次更新日期和时间。</td></tr><tr><td>username</td><td>字符串</td><td>用于连接的用户名。</td></tr><tr><td>using_remote_query_agent</td><td>布尔值</td><td>指示数据连接是否使用 Tableau Bridge。</td></tr></tbody></table>

## datasources

`datasources` 实体类型包含有关已发布数据源的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>certification_note</td><td>字符串</td><td>认证状态的解释。</td></tr><tr><td>certifier_details</td><td>字符串</td><td>认证者信息的快照。</td></tr><tr><td>certifier_user_id</td><td>整数</td><td>认证数据源的用户的 ID。如果数据源未经认证，则此值为 null。</td></tr><tr><td>connectable</td><td>布尔值</td><td>指示数据源是否支持通过 Data Server 进行连接。</td></tr><tr><td>content_version</td><td>整数</td><td>随每次发布更新的数据源的版本号。</td></tr><tr><td>created_at</td><td>时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>data_engine_extracts</td><td>布尔值</td><td>指示数据是否以 Tableau 数据提取的形式提供。</td></tr><tr><td>db_class</td><td>字符串</td><td>数据连接的类型，例如 Excel 或 Oracle。</td></tr><tr><td>db_name</td><td>字符串</td><td>数据库的名称或数据源的文件路径。</td></tr><tr><td>description</td><td>字符串</td><td>数据源的描述。</td></tr><tr><td>document_version</td><td>字符串</td><td>此记录的 .tds 文件的内部版本。</td></tr><tr><td>extracts_incremented_at</td><td>时间戳</td><td>上次增量数据提取刷新的日期和时间。</td></tr><tr><td>extracts_refreshed_at</td><td>时间戳</td><td>上次完全数据提取刷新的日期和时间。</td></tr><tr><td>first_published_at</td><td>时间戳</td><td>数据源首次发布的日期和时间。</td></tr><tr><td>hidden_name</td><td>字符串</td><td>从文件中提取的数据源的自动生成名称。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>incrementable_extracts</td><td>布尔值</td><td>指示是否允许对已发布数据源进行增量数据提取。</td></tr><tr><td>is_certified</td><td>布尔值</td><td>指示数据源是否经过认证。</td></tr><tr><td>is_hierarchical</td><td>布尔值</td><td>如果为 true，则数据源为分层（多维数据集）数据库。</td></tr><tr><td>last_published_at</td><td>时间戳</td><td>数据源上次发布的日期和时间。</td></tr><tr><td>luid</td><td>字符串</td><td>数据源的唯一标识符。</td></tr><tr><td>modified_by_user_id</td><td>整数</td><td>上次修改和发布数据源的用户的 ID。对于较旧的记录，此值与 owner_id 相同。</td></tr><tr><td>name</td><td>字符串</td><td>已发布数据源的名称。</td></tr><tr><td>owner_id</td><td>整数</td><td>数据数据源所有者或上载者的用户 ID。</td></tr><tr><td>parent_type</td><td>字符串</td><td>数据源的父类型。datarole、workbook 或 null。</td></tr><tr><td>parent_workbook_id</td><td>整数</td><td>包含此数据源的工作簿的 ID。对于已发布数据源，此值为 null。</td></tr><tr><td>refreshable_extracts</td><td>布尔值</td><td>指示可刷新数据提取对于已发布数据源是否可用。</td></tr><tr><td>remote_query_agent_id</td><td>整数</td><td>用于远程查询的代理的 ID。</td></tr><tr><td>repository_url</td><td>字符串</td><td>URL 中使用的数据源的唯一名称。</td></tr><tr><td>revision</td><td>字符串</td><td>数据源的版本号，每次发布时递增。</td></tr><tr><td>site_id</td><td>整数</td><td>与数据源关联的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>size</td><td>长整数</td><td>数据源的大小（以字节为单位）。</td></tr><tr><td>state</td><td>字符串</td><td>发布状态。active 或 archived。</td></tr><tr><td>table_name</td><td>字符串</td><td>与已发布数据源关联的表或工作表的名称。</td></tr><tr><td>updated_at</td><td>时间戳</td><td>记录的上次更新日期和时间。</td></tr><tr><td>using_remote_query_agent</td><td>布尔值</td><td>指示对此数据源的查询是否使用远程代理。</td></tr></tbody></table>

## flows

`flows` 实体类型包含有关已发布流程的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>content_version</td><td>整数</td><td>随每次发布更新的流程的版本号。</td></tr><tr><td>created_at</td><td>时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>data_engine_extracts</td><td>布尔值</td><td>指示数据是否以 Tableau 数据提取的形式提供。</td></tr><tr><td>description</td><td>字符串</td><td>流程的描述。</td></tr><tr><td>document_version</td><td>字符串</td><td>此记录的 .tfl 文件的内部版本。</td></tr><tr><td>file_type</td><td>字符串</td><td>文件类型。.tfl 或 .tflx。</td></tr><tr><td>hidden</td><td>布尔值</td><td>指示是否从内容管理系统中隐藏流程。</td></tr><tr><td>id</td><td>整数</td><td>流程的唯一标识符。</td></tr><tr><td>is_deleted</td><td>布尔值</td><td>指示流程是否在回收站中。在恢复之前，已删除的流程对活动作业或用户请求不可见。</td></tr><tr><td>kind</td><td>字符串</td><td>流程的类型。</td></tr><tr><td>last_published_at</td><td>时间戳</td><td>上次发布流程的日期和时间。</td></tr><tr><td>luid</td><td>uuid</td><td>流程的唯一标识符。</td></tr><tr><td>name</td><td>字符串</td><td>已发布流程的名称。</td></tr><tr><td>owner_id</td><td>整数</td><td>流程所有者或发布者的用户 ID。</td></tr><tr><td>project_id</td><td>整数</td><td>与流程关联的项目的 ID。</td></tr><tr><td>site_id</td><td>整数</td><td>与流程关联的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>size</td><td>长整数</td><td>流程文件的大小（以字节为单位）。</td></tr><tr><td>state</td><td>字符串</td><td>流程的状态。active 或 archived。默认值为 active。</td></tr><tr><td>updated_at</td><td>时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## group\_users

`group_users` 实体类型包含有关分配到组的用户的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>group_id</td><td>整数</td><td>组的 ID。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>site_id</td><td>整数</td><td>组用户的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>user_id</td><td>整数</td><td>用户的 ID。</td></tr></tbody></table>

## groups

`groups` 实体类型包含有关用户组的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>created_at</td><td>时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>domain_id</td><td>整数</td><td>与组关联的域的 ID。</td></tr><tr><td>external_user_enabled</td><td>布尔值</td><td>指示是否可以将外部用户添加到组。</td></tr><tr><td>grant_license_mode</td><td>字符串</td><td>指示何时向组成员授予许可证。ON_SYNC 或 ON_LOGIN。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>last_synchronized</td><td>时间戳</td><td>Active Directory 组上次同步的日期和时间。</td></tr><tr><td>luid</td><td>uuid</td><td>与站点 ID 组合时唯一的标识符。</td></tr><tr><td>minimum_site_role</td><td>字符串</td><td>为 Active Directory 组的成员分配的最低站点角色。</td></tr><tr><td>minimum_site_role_id</td><td>整数</td><td>组的最低站点角色的 ID。</td></tr><tr><td>name</td><td>字符串</td><td>组的名称。</td></tr><tr><td>owner_id</td><td>整数</td><td>拥有组的用户的 ID。</td></tr><tr><td>site_id</td><td>整数</td><td>组所属的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>system</td><td>布尔值</td><td>指示组是由 Tableau 还是用户创建的。</td></tr><tr><td>updated_at</td><td>时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## next\_gen\_permissions

`next_gen_permissions` 实体类型包含有关分配给用户、组和组集的权限的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>authorizable_id</td><td>整数</td><td>为其指定权限的内容的 ID。</td></tr><tr><td>authorizable_type</td><td>字符串</td><td>为其指定权限的内容的类型。“Project”、“Workbook”、“DataSource”、“View”或“NamedResource”。</td></tr><tr><td>capability_id</td><td>整数</td><td>被授予或拒绝的能力的 ID。</td></tr><tr><td>grantee_id</td><td>整数</td><td>被授予权限的用户、组或组集的 ID。</td></tr><tr><td>grantee_type</td><td>字符串</td><td>被授权者的类型。User、Group 或 GroupAND。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>permission</td><td>整数</td><td>权限级别，指示是向用户或组授予还是拒绝能力。值 1 = 授予组，2 = 拒绝组，3 = 授予用户，4 = 拒绝用户。较高的值优先。例如，特定于用户的授予可以覆盖组级别的拒绝。</td></tr><tr><td>site_id</td><td>整数</td><td>权限所属的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr></tbody></table>

## projects

`projects` 实体类型包含有关用于组织内容的项目的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>admin_insights_enabled</td><td>布尔值</td><td>指明项目是否为“在线管理见解”项目。</td></tr><tr><td>controlled_permissions_enabled</td><td>布尔值</td><td>指示是否在项目级别控制权限。</td></tr><tr><td>controlling_permissions_project_id</td><td>整数</td><td>控制此项目权限的祖先项目的 ID。</td></tr><tr><td>created_at</td><td>时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>description</td><td>字符串</td><td>项目的描述。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>luid</td><td>uuid</td><td>记录的唯一标识符。</td></tr><tr><td>name</td><td>字符串</td><td>项目的名称。</td></tr><tr><td>nested_projects_permissions_included</td><td>布尔值</td><td>指示是否在项目级别控制嵌套项目的权限。</td></tr><tr><td>owner_id</td><td>整数</td><td>拥有项目的用户的 ID。</td></tr><tr><td>parent_project_id</td><td>整数</td><td>父项目的 ID。对于顶层项目，此值为 null。</td></tr><tr><td>site_id</td><td>整数</td><td>包含项目的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>special</td><td>整数</td><td>指示这是否是系统创建的项目，例如“默认”项目。对于系统创建的项目，值为 1，否则，值为 null。</td></tr><tr><td>state</td><td>字符串</td><td>项目的状态。active 或 inactive。</td></tr><tr><td>updated_at</td><td>时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## projects\_contents

`projects_contents` 实体类型包含有关项目中存储的内容的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>content_id</td><td>整数</td><td>项目中存储的内容的 Id，用 project_id 表示。与 content_type 结合使用以唯一标识内容。</td></tr><tr><td>content_type</td><td>字符串</td><td>项目中的内容类型。与 content_id 结合使用以唯一标识内容。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>project_id</td><td>整数</td><td>与记录关联的项目的 ID。</td></tr><tr><td>site_id</td><td>整数</td><td>与记录关联的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr></tbody></table>

## published\_connection\_revision\_tables

`published_connection_revision_tables` 实体类型包含有关与已发布连接修订关联的表的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>published_connection_table_luid</td><td>uuid</td><td>关联的已发布连接表的 ID。</td></tr><tr><td>revisable_properties</td><td>jsonb</td><td>用户可以修订的属性。</td></tr><tr><td>revision_id</td><td>整数</td><td>关联修订的 ID。</td></tr><tr><td>site_id</td><td>整数</td><td>关联站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>system_properties</td><td>jsonb</td><td>系统元数据。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## published\_connection\_revisions

`published_connection_revisions` 实体类型包含有关已发布连接的修订的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>luid</td><td>uuid</td><td>站点内修订的唯一标识符。</td></tr><tr><td>owner_id</td><td>整数</td><td>拥有修订的用户的 ID。</td></tr><tr><td>published_at</td><td>无时区的时间戳</td><td>此修订的发布日期和时间。</td></tr><tr><td>published_connection_id</td><td>整数</td><td>关联的已发布连接的 ID。</td></tr><tr><td>revisable_properties</td><td>jsonb</td><td>用户可以修订的属性。</td></tr><tr><td>revisable_properties_updated_at</td><td>无时区的时间戳</td><td>可修订属性的上次更新日期和时间。</td></tr><tr><td>revisable_properties_version</td><td>整数</td><td>每次更新可修订属性时递增的数字。</td></tr><tr><td>revision_type</td><td>整数</td><td>修订的类型。值 0 = 草稿、1 = 活动、2 = 历史。</td></tr><tr><td>site_id</td><td>整数</td><td>关联站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>system_properties</td><td>jsonb</td><td>系统元数据。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr><tr><td>version_number</td><td>整数</td><td>修订的递增版本号。</td></tr></tbody></table>

## published\_connection\_tables

`published_connection_tables` 实体类型包含有关与已发布连接关联的表的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>description</td><td>字符串</td><td>已发布连接表的描述。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>luid</td><td>uuid</td><td>站点内表的唯一标识符。</td></tr><tr><td>name</td><td>字符串</td><td>已发布连接表的名称。</td></tr><tr><td>published_connection_id</td><td>整数</td><td>关联的已发布连接的 ID。</td></tr><tr><td>site_id</td><td>整数</td><td>关联站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## published\_connections

`published_connections` 实体类型包含有关已发布连接的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>activated</td><td>布尔值</td><td>指示已发布连接是否可供使用。</td></tr><tr><td>created_at</td><td>时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>description</td><td>字符串</td><td>已发布连接的描述。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>luid</td><td>uuid</td><td>站点内连接的唯一标识符。</td></tr><tr><td>name</td><td>字符串</td><td>已发布连接的名称。</td></tr><tr><td>owner_id</td><td>整数</td><td>拥有连接的用户的 ID。</td></tr><tr><td>project_id</td><td>整数</td><td>关联项目的 ID。</td></tr><tr><td>site_id</td><td>整数</td><td>关联站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>updated_at</td><td>时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## schedules

`schedules` 实体类型包含有关用于运行任务的计划的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>actionable</td><td>布尔值</td><td>指示计划是否可操作。</td></tr><tr><td>active</td><td>布尔值</td><td>指示计划是否处于活动状态。如果为 false，则触发计划时不运行任何任务。</td></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>day_of_month_mask</td><td>整数</td><td>一个编码值，指示计划在一个月中的哪几天运行。将值转换为二进制进行解读，其中每个二进制位代表一个月中的某一天。值 1 = 第一天，10 = 第二天，100 = 第三天，依此类推。</td></tr><tr><td>day_of_week_mask</td><td>整数</td><td>一个编码值，指示计划在一周中的哪几天运行。将值转换为二进制进行解读，其中每个二进制位代表一周中的某一天。值 1 = 星期日、10 = 星期一、100 = 星期二、1000 = 星期三、10000 = 星期四、100000 = 星期五、1000000 = 星期六。</td></tr><tr><td>defined_by</td><td>整数</td><td>创建计划的机制类型，例如 0 表示系统管理员，1 表示自助服务。</td></tr><tr><td>end_at_minute</td><td>整数</td><td>计划在其频率周期内停止触发的分钟。</td></tr><tr><td>end_schedule_at</td><td>无时区的时间戳</td><td>计划不再触发的日期和时间。</td></tr><tr><td>hidden</td><td>布尔值</td><td>指示计划在界面中是否可见。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>linked_task_enabled</td><td>布尔值</td><td>指示用户是否可以按此计划创建链接任务。</td></tr><tr><td>luid</td><td>uuid</td><td>REST API 中使用的计划的唯一标识符。</td></tr><tr><td>minute_interval</td><td>整数</td><td>计划在启动后重新触发的时间间隔。由 schedule_type、end_at_minute 或 end_schedule_at 定义。</td></tr><tr><td>name</td><td>字符串</td><td>计划的名称。</td></tr><tr><td>priority</td><td>整数</td><td>计划的优先级，从 1（最高）到 100（最低）。</td></tr><tr><td>run_next_at</td><td>无时区的时间戳</td><td>计划下次触发的日期和时间。</td></tr><tr><td>schedule_type</td><td>整数</td><td>计划的频率。值 0（每小时）、1（每天）、2（每周）、和 3（每月）。</td></tr><tr><td>scheduled_action</td><td>整数</td><td>分配给计划的任务类型。值 0 = 数据提取、1 = 订阅、2 = Active Directory 同步、3 = 自动刷新数据提取，4 = 流程。</td></tr><tr><td>serial_collection_id</td><td>整数</td><td>用于防止同时处理链接作业的 ID。具有相同 serial_collection_id 的作业不能同时运行。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>start_at_minute</td><td>整数</td><td>计划在其频率周期内开始的分钟。例如，对于每日计划，这是午夜过后的分钟数。</td></tr><tr><td>timezoneid</td><td>字符串</td><td>计划的 IANA 时区，例如 America/Los_Angeles。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## subscriptions

`subscriptions` 实体类型包含有关为用户配置的订阅的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>attach_image</td><td>布尔值</td><td>指示是否将图像附加到订阅电子邮件。</td></tr><tr><td>attach_pdf</td><td>布尔值</td><td>指示是否将 PDF 附加到订阅电子邮件。</td></tr><tr><td>content_has_user_references</td><td>布尔值</td><td>指示订阅内容是否包括用户引用。Null 表示订阅尚未运行。</td></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>creator_id</td><td>整数</td><td>创建订阅的用户的 ID。</td></tr><tr><td>data_condition_type</td><td>字符串</td><td>触发订阅的数据条件的类型。默认值为 Always。其他值包括 DataPresent、Constant、Band 等。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>is_refresh_extract_triggered</td><td>布尔值</td><td>指示订阅是否由数据提取刷新触发。</td></tr><tr><td>last_sent</td><td>无时区的时间戳</td><td>上次发送订阅的日期和时间。</td></tr><tr><td>luid</td><td>uuid</td><td>REST API 中使用的订阅的唯一标识符。</td></tr><tr><td>schedule_id</td><td>整数</td><td>触发订阅的计划的 ID。</td></tr><tr><td>site_id</td><td>整数</td><td>订阅所在站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>subject</td><td>字符串</td><td>订阅的主题行或描述。</td></tr><tr><td>subscription_message_id</td><td>整数</td><td>订阅消息的的 ID。</td></tr><tr><td>target_id</td><td>整数</td><td>所订阅内容的 ID。</td></tr><tr><td>target_type</td><td>字符串</td><td>所订阅内容的类型。View 或 Workbook。</td></tr><tr><td>user_id</td><td>整数</td><td>接收订阅的用户的 ID。</td></tr></tbody></table>

## system\_users

`system_users` 实体类型包含有关系统级用户帐户的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>admin_level</td><td>整数</td><td>指示用户是否为系统管理员。值 10 = 系统管理员，0 = 不是系统管理员。</td></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>custom_display_name</td><td>布尔值</td><td>指示是否防止友好名称被 Active Directory 覆盖。</td></tr><tr><td>domain_id</td><td>整数</td><td>用户的域的 ID。</td></tr><tr><td>email</td><td>字符串</td><td>用户的电子邮件地址。</td></tr><tr><td>failed_login_attempts</td><td>整数</td><td>自上次成功登录以来失败登录尝试的次数。</td></tr><tr><td>force_password_update</td><td>布尔值</td><td>指示用户是否必须在下次登录时重置其密码。</td></tr><tr><td>friendly_name</td><td>字符串</td><td>界面中用于引用用户的友好名称。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>last_failed_login</td><td>无时区的时间戳</td><td>用户上次登录失败的日期和时间。</td></tr><tr><td>last_password_update</td><td>无时区的时间戳</td><td>用户上次更新其密码的日期和时间。</td></tr><tr><td>name</td><td>字符串</td><td>用户名。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## taggings

`taggings` 实体类型包含有关标记和标记内容之间的关系的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>site_id</td><td>整数</td><td>标记所属的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>tag_id</td><td>整数</td><td>标记的 ID。</td></tr><tr><td>taggable_id</td><td>整数</td><td>标记项的 ID。</td></tr><tr><td>taggable_type</td><td>字符串</td><td>所标记的项的类型。此值标识要联接到哪个表。</td></tr><tr><td>user_id</td><td>整数</td><td>拥有标记的用户的 ID。</td></tr></tbody></table>

## tags

`tags` 实体类型包含有关用于标记内容的标记的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>name</td><td>字符串</td><td>标记的名称。</td></tr><tr><td>site_id</td><td>整数</td><td>标记所属的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## tasks

`tasks` 实体类型包含有关计划任务的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>active</td><td>布尔值</td><td>指示任务是否处于活动状态。如果为 false，则触发计划时不运行任务。</td></tr><tr><td>args</td><td>字符串</td><td>格式为 YAML 的任务参数。</td></tr><tr><td>consecutive_failure_count</td><td>整数</td><td>此任务的失败次数。</td></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>creator_id</td><td>整数</td><td>创建任务的用户的 ID。</td></tr><tr><td>historical_queue_time</td><td>整数</td><td>任务的历史排队时间（以秒为单位）。</td></tr><tr><td>historical_run_time</td><td>整数</td><td>任务的历史运行时间（以秒为单位）。</td></tr><tr><td>id</td><td>整数</td><td>任务的唯一标识符。</td></tr><tr><td>last_success_completed_at</td><td>无时区的时间戳</td><td>任务上次成功完成的日期和时间。</td></tr><tr><td>luid</td><td>uuid</td><td>REST API 中使用的任务的唯一标识符。</td></tr><tr><td>obj_id</td><td>整数</td><td>与任务关联的工作簿或数据源的 ID。</td></tr><tr><td>obj_type</td><td>字符串</td><td>与任务关联的对象的类型。工作簿或数据源。与 obj_id 结合使用以唯一标识对象。</td></tr><tr><td>priority</td><td>整数</td><td>任务的优先级，其中 0 为最高优先级，10 为默认值。</td></tr><tr><td>run_count</td><td>整数</td><td>自添加此字段以来任务已运行的次数。对于在字段存在之前创建的任务，此值可能不准确。</td></tr><tr><td>schedule_id</td><td>整数</td><td>链接到任务的计划的 ID。当计划的 run_next_at 时间到达时，链接的任务将运行。</td></tr><tr><td>site_id</td><td>整数</td><td>与任务关联的站点的 ID。用于特定于站点的任务。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>state</td><td>整数</td><td>任务的当前状态。值 0 = 活动、1 = 暂停、2 = 禁用。</td></tr><tr><td>subtitle</td><td>字符串</td><td>有关任务的附加信息。</td></tr><tr><td>title</td><td>字符串</td><td>有关任务的附加信息。</td></tr><tr><td>type</td><td>字符串</td><td>任务的类型。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## users

`users` 实体类型包含有关站点用户的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>login_at</td><td>无时区的时间戳</td><td>用户最近登录的日期和时间。</td></tr><tr><td>luid</td><td>uuid</td><td>记录的唯一标识符。</td></tr><tr><td>site_id</td><td>整数</td><td>用户所属的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>site_role_id</td><td>整数</td><td>用户的站点角色的 ID。值 0 = SiteAdministrator，1 = SupportUser，2 = Publisher，3 = Interacto ，4 = ViewerWithPublish，5 = Viewer，6 = UnlicensedWithPublish，7 = Guest，8 = Unlicensed 以及 9 = BasicUser。</td></tr><tr><td>system_admin_auto</td><td>布尔值</td><td>指示用户是否为未明确分配给站点的系统管理员。</td></tr><tr><td>system_user_id</td><td>整数</td><td>与此用户关联的系统用户的 ID。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr></tbody></table>

## views

`views` 实体类型包含有关工作簿中的视图的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>说明</td><td>字符串</td><td>基于工作簿定义的工作表描述。</td></tr><tr><td>created_at</td><td>无时区的时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>description</td><td>字符串</td><td>视图的描述。</td></tr><tr><td>fields</td><td>字符串</td><td>从工作簿 .twb 文件中提取的字段。</td></tr><tr><td>first_published_at</td><td>无时区的时间戳</td><td>视图首次发布的日期和时间。此值在包含视图的工作簿后重新发布时不会更改。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>index</td><td>整数</td><td>视图在其工作簿中的索引号。</td></tr><tr><td>is_deleted</td><td>布尔值</td><td>指示视图是否位于回收站中。</td></tr><tr><td>luid</td><td>uuid</td><td>记录的唯一标识符。</td></tr><tr><td>name</td><td>字符串</td><td>视图的名称。</td></tr><tr><td>owner_id</td><td>整数</td><td>拥有视图的用户的 ID。</td></tr><tr><td>repository_url</td><td>字符串</td><td>URL 中使用的视图的唯一名称。</td></tr><tr><td>revision</td><td>字符串</td><td>视图的版本号。值从 1.0 开始，并在每次重新发布时按 0.1 递增。</td></tr><tr><td>sheet_id</td><td>字符串</td><td>工作表的标识符。</td></tr><tr><td>sheettype</td><td>字符串</td><td>工作表的类型。story、dashboard 或 view。</td></tr><tr><td>site_id</td><td>整数</td><td>视图所属的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>state</td><td>字符串</td><td>视图的状态。active 或 disabled。</td></tr><tr><td>title</td><td>字符串</td><td>从工作簿 .twb 文件中提取的工作表的标题。</td></tr><tr><td>updated_at</td><td>无时区的时间戳</td><td>记录的上次更新日期和时间。</td></tr><tr><td>workbook_id</td><td>整数</td><td>包含视图的工作簿的 ID。</td></tr></tbody></table>

## workbooks

`workbooks` 实体类型包含有关已发布工作簿的信息。

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"><col style="width: 15%;"><col></colgroup><tbody><tr><th>文件名</th><th>类型</th><th>描述</th></tr><tr><td>content_version</td><td>整数</td><td>随每次发布更新的工作簿的版本号。</td></tr><tr><td>created_at</td><td>时间戳</td><td>此记录的创建日期和时间。</td></tr><tr><td>data_engine_extracts</td><td>布尔值</td><td>指明工作簿是否有关联的数据引擎数据提取。</td></tr><tr><td>default_view_index</td><td>整数</td><td>指明默认情况下是否显示视图。</td></tr><tr><td>display_tabs</td><td>布尔值</td><td>如果为 true，则工作表在工作簿中显示为标签。</td></tr><tr><td>document_version</td><td>字符串</td><td>保存工作簿时使用的文档描述的版本。</td></tr><tr><td>first_published_at</td><td>时间戳</td><td>工作簿首次发布的日期和时间。重新发布工作簿时，此值不会更改。</td></tr><tr><td>id</td><td>整数</td><td>记录的唯一标识符。</td></tr><tr><td>incrementable_extracts</td><td>布尔值</td><td>指示此工作簿是否可以进行增量数据提取刷新。</td></tr><tr><td>is_deleted</td><td>布尔值</td><td>指示工作簿是否位于回收站中。在恢复之前，已删除的工作簿对活动作业或用户请求不可见。</td></tr><tr><td>last_published_at</td><td>时间戳</td><td>工作簿上次发布的日期和时间。</td></tr><tr><td>luid</td><td>uuid</td><td>记录的唯一标识符。</td></tr><tr><td>modified_by_user_id</td><td>整数</td><td>上次修改和发布工作簿的用户的 ID。对于较旧的记录，此值与 owner_id 相同。</td></tr><tr><td>name</td><td>字符串</td><td>工作簿名称。</td></tr><tr><td>owner_id</td><td>整数</td><td>拥有此工作簿的用户的 ID。</td></tr><tr><td>published_all_sheets</td><td>布尔值</td><td>指示是否已发布工作簿中的所有工作表。</td></tr><tr><td>refreshable_extracts</td><td>布尔值</td><td>指示工作簿中的数据提取是否可刷新。</td></tr><tr><td>repository_url</td><td>字符串</td><td>URL 中使用的工作簿的唯一名称。</td></tr><tr><td>revision</td><td>字符串</td><td>工作簿的版本号。值从 1.0 开始，并在每次重新发布时按 0.1 递增。</td></tr><tr><td>site_id</td><td>整数</td><td>发布工作簿的站点的 ID。</td></tr><tr><td>site_luid</td><td>字符串</td><td>站点的 LUID。</td></tr><tr><td>size</td><td>长整型</td><td>工作簿的大小（以字节为单位）。</td></tr><tr><td>thumb_user</td><td>整数</td><td>用于生成缩略图的用户的 ID。除非指定，否则此值为 null。</td></tr><tr><td>updated_at</td><td>时间戳</td><td>记录的上次更新日期和时间。</td></tr><tr><td>view_count</td><td>整数</td><td>与此工作簿关联的视图的总数。</td></tr></tbody></table>