實體快照參考

本主題會介紹透過 Tableau Cloud Manager REST API 可用的實體快照表和欄位。有關實體快照的詳情,請參閱使用實體快照平台資料(連結在新視窗開啟)

實體快照表

請使用右側按字母順序排列的實體表清單,或使用 ctrl/cmd-f 直接前往您想到的關鍵字。

附註:時間戳記以 ISO 8601 UTC 格式記錄。

capabilities

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 Proxy。
dbname字串此連線的資料庫的名稱。
has_extract布林值表示資料連線是否為擷取。
id整數記錄的唯一識別碼。
keychain字串YAML 格式的編碼字串。
luiduuid用於識別 Tableau REST API 中連線的唯一識別碼。Tableau 會自動產生此值。
name字串資料連線的唯一名稱。
owner_id整數建立資料連線的工作簿或資料來源的 ID。
owner_type字串建立資料連線的內容的類型。工作簿或資料來源。
password布林值表示密碼是否內嵌在擁有者中。
port整數連線的連接埠號碼。
query_tagging_enabled布林值表示針對此資料連線的查詢在 Tableau 中是否使用有關其來源的資訊進行標記。
server字串連線的伺服器的名稱。
site_id整數資料連線所在站台的 ID。
site_luid字串站台的 LUID。
state字串發佈狀態。使用中或已封存。
tablename字串連線的資料庫資料表的名稱。
updated_at時間戳記記錄的上次更新日期和時間。
username字串用於連線的使用者名稱。
using_remote_query_agent布林值表示資料連線是否使用 Tableau Bridge。

datasources

datasources 實體類型包含有關已發佈資料來源的資訊。

欄位名稱類型描述
certification_note字串認證狀態的說明。
certifier_details字串認證者資訊的快照。
certifier_user_id整數認證資料來源的使用者的 ID。若資料來源未經過認證,則此值為 Null。
connectable布林值表示資料來源是否支援透過資料伺服器進行連線。
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字串資料來源的父類型。資料角色、工作簿或 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字串發佈狀態。使用中或已封存。
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時間戳記流程的上次發佈日期和時間。
luiduuid流程的唯一識別碼。
name字串已發佈流程的名稱。
owner_id整數流程擁有者或發佈者的使用者 ID。
project_id整數與流程關聯的專案的 ID。
site_id整數與流程關聯的站台的 ID。
site_luid字串站台的 LUID。
size長整數流程檔案的大小(以位元組為單位)。
state字串流程的狀態。使用中或已封存。預設為使用中。
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 群組的上次同步日期和時間。
luiduuid與站台 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字串為其指定權限的內容的類型。「專案」、「工作簿」、「資料來源」、「檢視」或「具名資源」。
capability_id整數被授與或拒絕的功能的 ID。
grantee_id整數被授與權限的使用者、群組或群組集的 ID。
grantee_type字串承授者的類型。「使用者」、「群組」或「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整數記錄的唯一識別碼。
luiduuid記錄的唯一識別碼。
name字串專案的名稱。
nested_projects_permissions_included布林值表示巢狀專案的權限是否在專案層級進行控制。
owner_id整數擁有專案的使用者的 ID。
parent_project_id整數父專案的 ID。對於最上層專案,此為 Null。
site_id整數包含專案的站台的 ID。
site_luid字串站台的 LUID。
special整數表示這是否為系統建立的專案,例如預設專案。對於系統建立的專案,值為 1,否則值為 Null。
state字串專案的狀態。使用中或非使用中。
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_luiduuid關聯的已發佈連線資料表的 ID。
revisable_propertiesjsonb使用者可以修訂的屬性。
revision_id整數關聯修訂的 ID。
site_id整數關聯站台的 ID。
site_luid字串站台的 LUID。
system_propertiesjsonb系統中繼資料。
updated_at無時區的時間戳記記錄的上次更新日期和時間。

published_connection_revisions

published_connection_revisions 實體類型包含有關已發佈連線修訂的資訊。

欄位名稱類型描述
created_at無時區的時間戳記此記錄的建立日期和時間。
id整數記錄的唯一識別碼。
luiduuid站台內修訂的唯一識別碼。
owner_id整數擁有修訂的使用者的 ID。
published_at無時區的時間戳記此修訂的發佈日期和時間。
published_connection_id整數關聯的已發佈連線的 ID。
revisable_propertiesjsonb使用者可以修訂的屬性。
revisable_properties_updated_at無時區的時間戳記可修訂屬性的上次更新日期和時間。
revisable_properties_version整數每次更新可修訂屬性時遞增的數字。
revision_type整數修訂的類型。值 0 = 草稿,1 = 使用中,2 = 歷史。
site_id整數關聯站台的 ID。
site_luid字串站台的 LUID。
system_propertiesjsonb系統中繼資料。
updated_at無時區的時間戳記記錄的上次更新日期和時間。
version_number整數修訂的遞增版本號碼。

published_connection_tables

published_connection_tables 實體類型包含有關與已發佈連線關聯的資料表的資訊。

欄位名稱類型描述
created_at無時區的時間戳記此記錄的建立日期和時間。
description字串已發佈連線資料表的說明。
id整數記錄的唯一識別碼。
luiduuid站台內資料表的唯一識別碼。
name字串已發佈連線資料表的名稱。
published_connection_id整數關聯的已發佈連線的 ID。
site_id整數關聯站台的 ID。
site_luid字串站台的 LUID。
updated_at無時區的時間戳記記錄的上次更新日期和時間。

published_connections

published_connections 實體類型包含有關已發佈連線的資訊。

欄位名稱類型描述
activated布林值表示已發佈連線是否可供使用。
created_at時間戳記此記錄的建立日期和時間。
description字串已發佈連線的說明。
id整數記錄的唯一識別碼。
luiduuid站台內連線的唯一識別碼。
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 = 第 1 日,10 = 第 2 日,100 = 第 3 日,依此類推。
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布林值表示使用者是否可以按此排程建立連結工作。
luiduuidREST 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無時區的時間戳記訂閱的上次傳送日期和時間。
luiduuidREST API 中使用的訂閱的唯一識別碼。
schedule_id整數觸發訂閱的排程的 ID。
site_id整數訂閱所在站台的 ID。
site_luid字串站台的 LUID。
subject字串訂閱的主旨列或說明。
subscription_message_id整數訂閱訊息的 ID。
target_id整數所訂閱內容的 ID。
target_type字串所訂閱內容的類型。檢視或工作簿。
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。

tags

tags 實體類型包含有關用於標示內容的標記的資訊。

欄位名稱類型描述
created_at無時區的時間戳記此記錄的建立日期和時間。
id整數記錄的唯一識別碼。
name字串標記的名稱。
site_id整數標記所屬站台的 ID。
site_luid字串站台的 LUID。
updated_at無時區的時間戳記記錄的上次更新日期和時間。

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無時區的時間戳記工作上次成功完成的日期和時間。
luiduuidREST 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無時區的時間戳記使用者最近一次登入的日期和時間。
luiduuid記錄的唯一識別碼。
site_id整數使用者所屬站台的 ID。
site_luid字串站台的 LUID。
site_role_id整數使用者的站台角色的 ID。值 0 = 站台管理員,1 = 支援使用者,2 = 發佈者,3 = Explorer,4 = Viewer (可發佈),5 = Viewer,6 = 未授權(可發佈),7 = 訪客,8 = 未授權和 9 = 基本使用者。
system_admin_auto布林值表示使用者是否為未明確指派給站台的系統管理員。
system_user_id整數與此使用者關聯的系統使用者的 ID。
updated_at無時區的時間戳記記錄的上次更新日期和時間。

views

views 實體類型包含有關工作簿中檢視的資訊。

欄位名稱類型描述
caption字串基於工作簿定義的工作表的說明。
created_at無時區的時間戳記此記錄的建立日期和時間。
description字串檢視的說明。
fields字串從工作簿的 .twb 檔案中擷取的欄位。
first_published_at無時區的時間戳記檢視的首次發佈日期和時間。若重新發佈包含檢視的工作簿,此值不會變更。
id整數記錄的唯一識別碼。
index整數檢視在其工作簿中的索引編號。
is_deleted布林值表示檢視是否位於回收筒中。
luiduuid記錄的唯一識別碼。
name字串檢視的名稱。
owner_id整數擁有檢視的使用者的 ID。
repository_url字串URL 中使用的檢視的唯一名稱。
revision字串檢視的版本號碼。值從 1.0 開始,每次重新發佈時遞增 0.1
sheet_id字串工作表的識別碼。
sheettype字串工作表的類型。故事、儀表板或檢視。
site_id整數檢視所屬站台的 ID。
site_luid字串站台的 LUID。
state字串檢視的狀態。使用中或已停用。
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時間戳記工作簿的上次發佈日期和時間。
luiduuid記錄的唯一識別碼。
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整數與工作簿關聯的檢視的總數。
感謝您的意見反應!已成功提交您的意見回饋。謝謝!