实体快照参考

适用于： Tableau Advanced Management

本主题介绍通过 Tableau Cloud Manager REST API 提供的实体快照表和字段。有关实体快照的详细信息，请参见使用实体快照和平台数据(链接在新窗口中打开)。

实体快照表

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

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

能力

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

文件名	类型	描述
description	字符串	对能力允许用户执行的操作的描述。
display_name	字符串	向用户显示的能力的名称。
display_order	整数	能力在界面中列出的顺序。
id	整数	记录的唯一标识符。
name	字符串	用于在代码中引用能力的名称或 ID。
site_luid	字符串	站点的 LUID。

data_connections

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

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

datasources

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

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

flows

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

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

group_users

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

文件名	类型	描述
group_id	整数	组的 ID。
id	整数	记录的唯一标识符。
site_id	整数	组用户的站点的 ID。
site_luid	字符串	站点的 LUID。
user_id	整数	用户的 ID。

groups

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

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

next_gen_permissions

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

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

projects

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

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

projects_contents

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

文件名	类型	描述
content_id	整数	项目中存储的内容的 Id，用 project_id 表示。与 content_type 结合使用以唯一标识内容。
content_type	字符串	项目中的内容类型。与 content_id 结合使用以唯一标识内容。
id	整数	记录的唯一标识符。
project_id	整数	与记录关联的项目的 ID。
site_id	整数	与记录关联的站点的 ID。
site_luid	字符串	站点的 LUID。

published_connection_revision_tables

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

文件名	类型	描述
created_at	无时区的时间戳	此记录的创建日期和时间。
id	整数	记录的唯一标识符。
published_connection_table_luid	uuid	关联的已发布连接表的 ID。
revisable_properties	jsonb	用户可以修订的属性。
revision_id	整数	关联修订的 ID。
site_id	整数	关联站点的 ID。
site_luid	字符串	站点的 LUID。
system_properties	jsonb	系统元数据。
updated_at	无时区的时间戳	记录的上次更新日期和时间。

published_connection_revisions

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

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

published_connection_tables

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

文件名	类型	描述
created_at	无时区的时间戳	此记录的创建日期和时间。
description	字符串	已发布连接表的描述。
id	整数	记录的唯一标识符。
luid	uuid	站点内表的唯一标识符。
name	字符串	已发布连接表的名称。
published_connection_id	整数	关联的已发布连接的 ID。
site_id	整数	关联站点的 ID。
site_luid	字符串	站点的 LUID。
updated_at	无时区的时间戳	记录的上次更新日期和时间。

published_connections

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

文件名	类型	描述
activated	布尔值	指示已发布连接是否可供使用。
created_at	时间戳	此记录的创建日期和时间。
description	字符串	已发布连接的描述。
id	整数	记录的唯一标识符。
luid	uuid	站点内连接的唯一标识符。
name	字符串	已发布连接的名称。
owner_id	整数	拥有连接的用户的 ID。
project_id	整数	关联项目的 ID。
site_id	整数	关联站点的 ID。
site_luid	字符串	站点的 LUID。
updated_at	时间戳	记录的上次更新日期和时间。

schedules

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

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

subscriptions

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

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

system_users

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

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

taggings

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

文件名	类型	描述
id	整数	记录的唯一标识符。
site_id	整数	标记所属的站点的 ID。
site_luid	字符串	站点的 LUID。
tag_id	整数	标记的 ID。
taggable_id	整数	标记项的 ID。
taggable_type	字符串	所标记的项的类型。此值标识要联接到哪个表。
user_id	整数	拥有标记的用户的 ID。

tasks

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

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

users

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

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

views

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

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

workbooks

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

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

回到顶部

感谢您的反馈!

您的反馈已成功提交。谢谢!

Tableau Cloud 帮助