エンティティ スナップショット リファレンス

適用先: Tableau Advanced Management

このトピックでは、Tableau Cloud Manager REST API を通じて利用できるエンティティ スナップショットのテーブルとフィールドについて説明します。エンティティ スナップショットの詳細については、エンティティ スナップショットの使用および「プラットフォーム データ」(新しいウィンドウでリンクが開く)を参照してください。

エンティティ スナップショットのテーブル

右側にあるアルファベット順に並べられたエンティティ テーブルのリストを使用するか、ctrl/cmd-f を使用して、目的のキーワードに直接移動します。

注: タイムスタンプは ISO 8601 UTC で記録されます。

capabilities

capabilities エンティティ タイプには、パーミッションによって付与または拒否できる機能に関する情報が含まれています。

フィールド名 タイプ 説明
description 文字列 その機能によってユーザーが実行できることの説明。
display_name 文字列 ユーザーに表示される機能名。
display_order 整数 インターフェイスに機能が一覧表示される順序。
id 整数 レコードの一意の識別子。
name 文字列 コードで機能を参照するために使用される名前または ID。
site_luid 文字列 サイトの LUID。

0data_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 文字列 パブリケーションの状態。アクティブまたはアーカイブ済み。
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 文字列 データ ソースの親タイプ。データ ロール、ワークブック、または Null のいずれか。
parent_workbook_id 整数 このデータ ソースを含むワークブックの ID。パブリッシュされたデータ ソースの場合は Null。
refreshable_extracts ブール値 パブリッシュされたデータ ソースに対して、更新可能な抽出が利用可能かどうかを示します。
remote_query_agent_id 整数 リモート クエリで使用されるエージェントの ID。
repository_url 文字列 URL で使用されるデータ ソースの一意の名前です。
revision 文字列 データ ソースのバージョン番号で、パブリッシュされるたびに増加します。
site_id 整数 データ ソースに関連付けられているサイトの ID。
site_luid 文字列 サイトの LUID。
size long データ ソースのサイズ (バイト単位)。
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 long フロー ファイルのサイズ (バイト単位)。
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 文字列 被付与者のタイプ。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 文字列 プロジェクトの状態。アクティブまたは非アクティブ。
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 整数 スケジュールが実行される月の日にちを示す、エンコードされた値。値を 2 進数に変換して解釈します。各バイナリの位置が、その月の日付を表します。値が 1 の場合は 1 日、10 の場合は 2 日、100 の場合は 3 日のようになります。
day_of_week_mask 整数 スケジュールが実行される曜日を示すエンコード化された値。値を 2 進数に変換して解釈します。各バイナリの位置は曜日を表します。値 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 整数 スケジュールがその頻度期間内に開始された時点。たとえば、毎日のスケジュールの場合、これは午前 0 時からの経過分数を表します。
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。
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 形式で書式設定されたタスク パラメーター。
taggable_type 整数 タグ付け可能なアイテムの種類。このフィールドは、結合先の表を識別するために使用されます。
created_at タイムスタンプ (タイムゾーンなし) このレコードが作成された日時。
creator_id 整数 タスクを作成したユーザーの ID。
historical_queue_time 整数 タスクがキューで待機していたこれまでの時間 (秒)。
historical_run_time 整数 タスクが実行されていたこれまでの時間 (秒)。
id 整数 テーブルの一意の識別子。
last_success_completed_at タイムスタンプ (タイムゾーンなし) タスクが最後に正常に完了した日時。
luid uuid REST API で使用されるタスクの一意の識別子。
updated_at 整数 タスクに関連付けられているワークブックまたはデータ ソースの 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 = Interactor (インタラクター)、4 = ViewerWithPublish (パブリッシュできるビューアー)、5 = Viewer (ビューアー)、6 = UnlicensedWithPublish (パブリッシュできるライセンスなし)、7 = Guest (ゲスト)、8 = Unlicensed (ライセンスなし)、9 = BasicUser (基本ユーザー)。
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 bigint ワークブックのサイズ (バイト単位)。
thumb_user 整数 サムネイル画像の生成に使用されるユーザーの ID。この値は、指定しない限り Null になります。
updated_at タイムスタンプ レコードが最後に更新された日時。
view_count 整数 ワークブックに関連付けられているビューの総数。
一番上に戻る
フィードバックをお送りいただき、ありがとうございます。フィードバックは正常に送信されました。ありがとうございます!