實體快照參考
本主題會介紹透過 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 格式的編碼字串。 |
| 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 | 字串 | 發佈狀態。使用中或已封存。 |
| 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 | 時間戳記 | 流程的上次發佈日期和時間。 |
| luid | uuid | 流程的唯一識別碼。 |
| 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 群組的上次同步日期和時間。 |
| 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 | 字串 | 為其指定權限的內容的類型。「專案」、「工作簿」、「資料來源」、「檢視」或「具名資源」。 |
| 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 | 整數 | 記錄的唯一識別碼。 |
| 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 | 字串 | 專案的狀態。使用中或非使用中。 |
| 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 = 第 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 | 布林值 | 表示使用者是否可以按此排程建立連結工作。 |
| 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 | 字串 | 所訂閱內容的類型。檢視或工作簿。 |
| user_id | 整數 | 接收訂閱的使用者的 ID。 |
system_users
system_users 實體類型包含有關系統層級使用者帳戶的資訊。
| 欄位名稱 | 類型 | 描述 |
|---|---|---|
| admin_level | 整數 | 表示使用者是否為系統管理員。值 10 = 系統管理員,0 = 非系統管理員。 |
| created_at | 無時區的時間戳記 | 此記錄的建立日期和時間。 |
| custom_display_name | 布林值 | 表示是否要防止 Active Directory 覆寫易記名稱。 |
| domain_id | 整數 | 使用者的網域的 ID。 |
| 字串 | 該使用者的電子郵件地址。 | |
| 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 | 無時區的時間戳記 | 工作上次成功完成的日期和時間。 |
| 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 = 站台管理員,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 | 布林值 | 表示檢視是否位於回收筒中。 |
| luid | uuid | 記錄的唯一識別碼。 |
| 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 | 時間戳記 | 工作簿的上次發佈日期和時間。 |
| 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 | 整數 | 與工作簿關聯的檢視的總數。 |
