データマート定義詳細取得

Get

/api/datamart_definitions/{datamart_definition_id}

データマート定義の詳細を取得します。

Security

API Key: ApiKeyAuth

Header parameter nameAuthorization

認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。
API KEYの作成方法は、TROCCO API KEYの作成を参照ください。

Path parameters

datamart_definition_id

integer (int64) Required

データマート定義IDを指定します。
TROCCO画面からIDを確認する場合は、API実行時に指定する各種パラメーターの確認方法を参照ください。

Responses

200

データマート定義詳細を返します。

Expand All

object

integer (int64)

データマート定義IDです。

Example1

name

string

データマート定義名です。

Exampletest

description

string

メモです。

Exampledesc

data_warehouse_type

string

データウェアハウスタイプです。

Examplebigquery

is_runnable_concurrently

boolean

ジョブの並列実行可否です。

Exampletrue

resource_group

integer (int64)

リソースグループIDです。

Example1

name

string

リソースグループ名です。

Exampleresource group

description

string | null

メモです。

Exampledescription

teams

Array of object

チームです。

Min items0

object

team_id

integer (int64)

チームIDです。

Example1

role

string

ロールです。

Valid values[ "administrator", "editor", "operator", "viewer" ]

Exampleadministrator

created_at

string

リソースグループの作成日時です。

Example2023-08-23T03:00:00.000+09:00

updated_at

string

リソースグループの更新日時です。

Example2023-08-23T03:00:00.000+09:00

custom_variable_settings

Array of object

カスタム変数一覧です。

object

name

string

カスタム変数の変数名を指定します。
変数名を$で囲ってください。

Example$start_time$

type

string

カスタム変数タイプです。
string: 文字列
timestamp: 時刻・日付（キューイング時）
timestamp_runtime: 時刻・日付（実行時）

Valid values[ "string", "timestamp", "timestamp_runtime" ]

Exampletimestamp_runtime

value

string

カスタム変数名を展開する値を指定します。
カスタム変数タイプがstringのときのみ有効です。

Examplejobs

quantity

integer (int64)

unit 時間の数を指定します。
カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

Example1

unit

string

時間の単位を指定します。
タイプがtimestampかtimestamp_runtime のときのみ有効です。

Valid values[ "hour", "date", "month" ]

Examplehour

direction

string

時間軸の方向です。
ago: 前
later: 後
タイプがtimestampかtimestamp_runtime のときのみ有効です。

Valid values[ "ago", "later" ]

Exampleago

format

string

日付フォーマットです。
タイプがtimestampかtimestamp_runtime のときのみ有効です。

Example%Y-%m-%d %H:%M:%S

time_zone

string

日付フォーマットの日時を解釈するタイムゾーンです。
タイプがtimestampかtimestamp_runtime のときのみ有効です。

ExampleEtc/UTC

datamart_bigquery_option

BigQueryの設定です。
データウェアハウスタイプがBigQueryの場合にのみ、この値は返されます。

bigquery_connection_id

integer (int64)

BigQueryの接続IDです。

query_mode

string

クエリ実行モードです。
insert: データ転送モード
query: 自由記述モード

Valid values[ "insert", "query" ]

query

string

実行クエリです。

Exampleselect * from tests

destination_dataset

string

出力先データセットです。
query_modeがinsertの場合のみ有効です。

destination_table

string

出力先テーブルです。
query_modeがinsertの場合のみ有効です。

write_disposition

string

書き込みモードです。
query_modeがinsertの場合のみ有効。
append: 追記
truncate: 全件洗い替え

Valid values[ "append", "truncate" ]

before_load

string

転送前に実行するクエリです。
query_modeがinsertの場合のみ有効です。

ExampleDELETE FROM tests

partitioning

string

パーティションタイプです。
query_modeがinsertの場合のみ有効です。
ingestion_time: 取り込み時間により分割
time_unit_column: フィールドにより分割

Valid values[ "ingestion_time", "time_unit_column" ]

partitioning_time

string

分割する期間の単位です。
query_modeがinsertの場合のみ有効です。

Valid values[ "DAY", "HOUR", "MONTH", "YEAR" ]

partitioning_field

string

分割するフィールド名です。
query_modeがinsertの場合のみ有効です。

clustering_fields

Array of string

クラスタ化列です。
query_modeがinsertの場合のみ有効です。

Min items0

Max items4

string

location

string

データ処理ローケーションです。
query_modeがqueryの場合のみ有効です。

datamart_snowflake_setting

Snowflakeの設定です。
データウェアハウスタイプがSnowflakeの場合にのみ、この値は返されます。

snowflake_connection_id

integer (int64)

Snowflakeの接続IDです。

query_mode

string

クエリ実行モードです。
insert: データ転送モード
query: 自由記述モード

Valid values[ "insert", "query" ]

query

string

実行クエリです。

Exampleselect * from tests

warehouse

string

実行対象の仮想ウェアハウスです。

ExampleEXAMPLE_WH

statement_timeout

integer (int32)

クエリのタイムアウト時間（秒）です。
0を指定した場合はSnowflakeのSTATEMENT_TIMEOUT_IN_SECONDSが利用されます。

destination_database

string

出力先データベースです。
query_modeがinsertの場合のみ有効です。

destination_schema

string

出力先スキーマです。
query_modeがinsertの場合のみ有効です。

destination_table

string

出力先テーブルです。
query_modeがinsertの場合のみ有効です。

write_disposition

string

書き込みモードです。
query_modeがinsertの場合のみ有効です。
append: 追記
replace: 洗い替え
truncate: 全件洗い替え

Valid values[ "append", "replace", "truncate" ]

datamart_databricks_setting

Databricksの設定です。
データウェアハウスタイプがDatabricksの場合にのみ、この値は返されます。

databricks_connection_id

integer (int64)

Databricksの接続IDです。

query_mode

string

クエリ実行モードです。
insert: データ転送モード
query: 自由記述モード

Valid values[ "insert", "query" ]

query

string

実行クエリです。

Exampleselect * from tests

write_disposition

string

書き込みモードです。
query_modeがinsertの場合のみ有効です。
append: 追記
replace: 全件洗い替え(既存のテーブルがDROPされてクエリ実行結果に置き換えられます)
truncate_insert: 全件洗い替え(既存のテーブルのレコードがTRUNCATEされて、クエリ実行結果に置き換えられます)

Valid values[ "append", "replace", "truncate_insert" ]

destination_catalog

string

出力先カタログです。
query_modeがinsertの場合のみ有効です。

destination_schema

string

出力先スキーマです。
query_modeがinsertの場合のみ有効です。

destination_table

string

出力先テーブルです。
query_modeがinsertの場合のみ有効です。

notifications

Array of object

通知一覧です。

object

destination_type

string

通知先です。

Valid values[ "slack", "email" ]

slack_channel_id

integer (int64)

slack channel IDです。
destination_typeがslackのとき必須です。

email_id

integer (int64)

Email IDです。
destination_typeがemailのとき必須です。

notification_type

string

通知タイプです。
job: ジョブ実行(終了/エラー)通知
record: レコード条件(超過/過不足)通知

Valid values[ "job", "record" ]

notify_when

string

通知条件です。
jobタイプのとき必須です。

Valid values[ "finished", "failed" ]

message

string

通知内容です。

record_count

integer (int64)

閾値のレコード数
recordタイプのとき必須です。

record_operator

string

レコード数の比較演算子です
recordタイプのとき必須
above: 以上
below: 以下

Valid values[ "above", "below" ]

schedules

Array of object

スケジュール一覧です。

object

frequency

string

スケジュールの頻度です。
hourly: 毎時
daily: 毎日
weekly: 毎週
monthly: 毎月

Valid values[ "hourly", "daily", "weekly", "monthly" ]

minute

integer (int64)

分の値を示します。

hour

integer (int64)

時間の値を示します。

day

integer (int64)

日にちの値を示します。

day_of_week

integer (int64)

曜日の値を示します。

time_zone

string

日時のタイムゾーンです。

ExampleEtc/UTC

labels

Array of object

ラベル一覧です。

object

integer (int64)

ラベルIDです

Example1

name

string

ラベル名です。

Examplefavorite

description

string | null

メモです。

Exampleお気に入り

color

string

ラベルの色です。

Example#e86115

created_at

string

ラベル作成日時です。

Example2023-08-23T03:00:00.000+09:00

updated_at

string

ラベルの更新日時です。

Example2023-08-23T03:00:00.000+09:00

created_at

string

データマート定義の作成日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-08-23T03:00:00.000+09:00

updated_at

string

データマート定義の更新日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-08-23T03:00:00.000+09:00

400

Bad request.
不正なリクエストです。

401

Not authenticated.
認証エラーです。API KEYをご確認ください。

Was this article helpful?