Contents x
    ワークフロー詳細取得
      • Print
      • PDF
      Contents

      ワークフロー詳細取得

        • Print
        • PDF
        Article summary

        Get
        /api/pipeline_definitions/{pipeline_definition_id}

        ワークフローの詳細を取得します。

        Security
        API Key
        Header parameter nameAuthorization

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

        Responses
        200

        ワークフローの詳細を返します。

        Expand All
        object
        id
        integer (int64)

        ワークフローID

        name
        string

        ワークフロー名

        resource_group_id
        integer (int64) | null

        リソースグループID

        description
        string | null

        ワークフロー詳細（メモ）

        max_task_parallelism
        integer (int64) | null

        ワークフロータスク同時実行数上限

        Default1
        Example1
        execution_timeout
        integer (int64) | null

        ワークフロー実行タイムアウト

        max_retries
        integer (int64) | null

        ワークフローリトライ回数上限

        min_retry_interval
        integer (int64) | null

        ワークフロー最小リトライ間隔

        is_concurrent_execution_skipped
        boolean | null

        すでにワークフロージョブが実行中の場合、ワークフロージョブの実行をスキップするかどうか

        is_stopped_on_errors
        boolean | null

        タスクが失敗した場合、ワークフロージョブを停止するかどうか

        labels
        Array of string | null

        ラベル

        string
        notifications
        Array of object | null

        ワークフロー通知

        object
        type
        string

        ワークフロー通知種別

        • job_execution: ワークフロー実行通知
        • job_time_alert: ワークフロー経過時間通知
        Valid values[ "job_execution", "job_time_alert" ]
        destination_type
        string

        ワークフロー通知先種別

        Valid values[ "slack", "email" ]
        notify_when
        string

        ワークフロー実行通知タイミング
        ワークフロー通知種別がjob_executionの場合は必須です。

        • finished: ワークフロー実行完了時
        • failed: ワークフロー実行失敗時
        Valid values[ "finished", "failed" ]
        time
        integer

        ワークフロー経過時間通知タイミング
        ワークフロー通知種別がjob_time_alertの場合は必須です。

        slack_config
        object

        Slack通知設定

        notification_id
        integer (int64)

        Slack通知先ID

        message
        string

        Slack通知メッセージ

        email_config
        object

        メール通知設定

        notification_id
        integer (int64)

        メール通知先 ID

        message
        string

        メール通知メッセージ

        schedules
        Array of object | null

        ワークフロースケジュール

        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
        tasks
        Array of object | null

        ワークフロータスク一覧

        object
        key
        string

        タスクキー
        タスクキーはタスクの依存関係を定義するために使用される識別子です。
        タスクキーには任意の文字列を指定できます。

        Examplet1
        type
        string

        タスク種別

        Valid values[ "bigquery_data_check", "http_request", "redshift_data_check", "slack_notify", "snowflake_data_check", "tableau_extract", "trocco_bigquery_datamart", "trocco_dbt", "trocco_pipeline", "trocco_redshift_datamart", "trocco_snowflake_datamart", "trocco_transfer_bulk", "trocco_transfer" ]
        bigquery_data_check_config
        object
        connection_id
        integer (int64)

        BigQuery接続情報ID

        name
        string

        BigQueryデータチェックタスク名

        query
        string

        クエリ

        operator
        string

        比較演算子

        Valid values[ "equal", "greater_equal", "greater", "less_equal", "less", "not_equal" ]
        query_result
        integer (int64)

        期待するクエリ結果

        accepts_null
        boolean

        クエリ結果がNULLの場合、データチェックが成功したものとして扱うかどうか

        custom_variables
        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
        http_request_config
        object
        name
        string

        タスク名

        connection_id
        integer (int64)

        HTTP接続情報ID

        http_method
        string

        HTTP メソッド

        url
        string

        URL

        request_body
        string

        リクエストボディ

        request_headers
        Array of object

        リクエストヘッダ

        object
        key
        string

        リクエストヘッダキー

        value
        string

        リクエストヘッダ値

        masking
        boolean

        リクエストヘッダ値をマスキングするかどうか

        request_parameters
        Array of object

        リクエストパラメータ

        object
        key
        string

        リクエストパラメータキー

        value
        string

        リクエストパラメータ値

        masking
        boolean

        リクエストパラメータ値をマスキングするかどうか

        custom_variables
        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
        redshift_data_check_config
        object
        connection_id
        integer (int64)

        Redshift接続情報ID

        name
        string

        Redshiftデータチェックタスク名

        query
        string

        クエリ

        operator
        string

        比較演算子

        Valid values[ "equal", "greater_equal", "greater", "less_equal", "less", "not_equal" ]
        query_result
        integer (int64)

        期待するクエリ結果

        accepts_null
        boolean

        クエリ結果がNULLの場合、データチェックが成功したものとして扱うかどうか

        database
        string

        データベース

        ExampleDEFAULT
        custom_variables
        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
        slack_notify_config
        object
        name
        string

        Slack通知タスク名

        ExampleExample
        connection_id
        integer (int64)

        Slack接続情報ID

        message
        string

        Slack通知メッセージ

        ignore_error
        boolean

        Slack通知が失敗した場合、タスク自体は成功したものとして扱うか

        snowflake_data_check_config
        object
        connection_id
        integer (int64)

        Snowflake接続情報ID

        name
        string

        Snowflakeデータチェックタスク名

        query
        string

        クエリ

        operator
        string

        比較演算子

        Valid values[ "equal", "greater_equal", "greater", "less_equal", "less", "not_equal" ]
        query_result
        integer (int64)

        期待するクエリ結果

        accepts_null
        boolean

        クエリ結果がNULLの場合、データチェックが成功したものとして扱うかどうか

        warehouse
        string

        ウェアハウス

        custom_variables
        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
        tableau_extract_config
        object
        name
        string

        Tableauデータ抽出タスク名

        connection_id
        integer (int64)

        Tableau接続情報ID

        task_id
        string

        TableauタスクID
        TableauタスクIDはTableau APIのレスポンスで確認できます。

        trocco_bigquery_datamart_config
        object
        definition_id
        integer (int64)

        BigQueryデータマート定義ID

        custom_variable_loop
        Array of object

        カスタム変数ループ設定

        object
        type
        string

        カスタム変数ループ種別

        Valid values[ "bigquery", "period", "redshift", "snowflake", "string" ]
        bigquery_config
        object
        connection_id
        integer (int64)

        Bigquery接続情報ID

        query
        string

        クエリ

        variables
        Array of string

        カスタム変数

        string
        period_config
        object
        interval
        string

        ループ間隔

        time_zone
        string

        タイムゾーン

        from
        object

        ループ開始タイミング

        value
        integer

        ループ開始タイミング値

        unit
        string

        ループ開始タイミング単位

        Valid values[ "date", "month", "year" ]
        to
        object

        ループ終了タイミング

        value
        integer

        ループ終了タイミング値

        unit
        string

        ループ終了タイミング

        Valid values[ "date", "month", "year" ]
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        offset
        object

        展開される値

        value
        integer

        展開される値

        unit
        string

        展開される値の単位

        Valid values[ "date_ago", "date_later", "month_ago", "month_later", "year_ago", "year_later" ]
        redshift_config
        object
        connection_id
        integer (int64)

        Redshift接続情報ID

        query
        string

        クエリ

        database
        string

        データベース

        variables
        Array of string

        カスタム変数

        string
        snowflake_config
        object
        connection_id
        integer (int64)

        Snowflake接続情報ID

        query
        string

        クエリ

        warehouse
        string

        ウェアハウス

        variables
        Array of string

        カスタム変数

        string
        string_config
        object
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        values
        Array of string

        カスタム変数値

        string
        trocco_dbt_config
        object
        definition_id
        integer (int64)

        dbtジョブ設定ID

        trocco_pipeline_config
        object
        definition_id
        integer (int64)

        ワークフロー定義ID

        custom_variable_loop
        Array of object

        カスタム変数ループ設定

        object
        type
        string

        カスタム変数ループ種別

        Valid values[ "bigquery", "period", "redshift", "snowflake", "string" ]
        bigquery_config
        object
        connection_id
        integer (int64)

        Bigquery接続情報ID

        query
        string

        クエリ

        variables
        Array of string

        カスタム変数

        string
        period_config
        object
        interval
        string

        ループ間隔

        time_zone
        string

        タイムゾーン

        from
        object

        ループ開始タイミング

        value
        integer

        ループ開始タイミング値

        unit
        string

        ループ開始タイミング単位

        Valid values[ "date", "month", "year" ]
        to
        object

        ループ終了タイミング

        value
        integer

        ループ終了タイミング値

        unit
        string

        ループ終了タイミング

        Valid values[ "date", "month", "year" ]
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        offset
        object

        展開される値

        value
        integer

        展開される値

        unit
        string

        展開される値の単位

        Valid values[ "date_ago", "date_later", "month_ago", "month_later", "year_ago", "year_later" ]
        redshift_config
        object
        connection_id
        integer (int64)

        Redshift接続情報ID

        query
        string

        クエリ

        database
        string

        データベース

        variables
        Array of string

        カスタム変数

        string
        snowflake_config
        object
        connection_id
        integer (int64)

        Snowflake接続情報ID

        query
        string

        クエリ

        warehouse
        string

        ウェアハウス

        variables
        Array of string

        カスタム変数

        string
        string_config
        object
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        values
        Array of string

        カスタム変数値

        string
        trocco_redshift_datamart_config
        object
        definition_id
        integer (int64)

        Redshiftデータマート定義ID

        custom_variable_loop
        Array of object

        カスタム変数ループ設定

        object
        type
        string

        カスタム変数ループ種別

        Valid values[ "bigquery", "period", "redshift", "snowflake", "string" ]
        bigquery_config
        object
        connection_id
        integer (int64)

        Bigquery接続情報ID

        query
        string

        クエリ

        variables
        Array of string

        カスタム変数

        string
        period_config
        object
        interval
        string

        ループ間隔

        time_zone
        string

        タイムゾーン

        from
        object

        ループ開始タイミング

        value
        integer

        ループ開始タイミング値

        unit
        string

        ループ開始タイミング単位

        Valid values[ "date", "month", "year" ]
        to
        object

        ループ終了タイミング

        value
        integer

        ループ終了タイミング値

        unit
        string

        ループ終了タイミング

        Valid values[ "date", "month", "year" ]
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        offset
        object

        展開される値

        value
        integer

        展開される値

        unit
        string

        展開される値の単位

        Valid values[ "date_ago", "date_later", "month_ago", "month_later", "year_ago", "year_later" ]
        redshift_config
        object
        connection_id
        integer (int64)

        Redshift接続情報ID

        query
        string

        クエリ

        database
        string

        データベース

        variables
        Array of string

        カスタム変数

        string
        snowflake_config
        object
        connection_id
        integer (int64)

        Snowflake接続情報ID

        query
        string

        クエリ

        warehouse
        string

        ウェアハウス

        variables
        Array of string

        カスタム変数

        string
        string_config
        object
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        values
        Array of string

        カスタム変数値

        string
        trocco_snowflake_datamart_config
        object
        definition_id
        integer (int64)

        Snowflakeデータマート定義ID

        custom_variable_loop
        Array of object

        カスタム変数ループ設定

        object
        type
        string

        カスタム変数ループ種別

        Valid values[ "bigquery", "period", "redshift", "snowflake", "string" ]
        bigquery_config
        object
        connection_id
        integer (int64)

        Bigquery接続情報ID

        query
        string

        クエリ

        variables
        Array of string

        カスタム変数

        string
        period_config
        object
        interval
        string

        ループ間隔

        time_zone
        string

        タイムゾーン

        from
        object

        ループ開始タイミング

        value
        integer

        ループ開始タイミング値

        unit
        string

        ループ開始タイミング単位

        Valid values[ "date", "month", "year" ]
        to
        object

        ループ終了タイミング

        value
        integer

        ループ終了タイミング値

        unit
        string

        ループ終了タイミング

        Valid values[ "date", "month", "year" ]
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        offset
        object

        展開される値

        value
        integer

        展開される値

        unit
        string

        展開される値の単位

        Valid values[ "date_ago", "date_later", "month_ago", "month_later", "year_ago", "year_later" ]
        redshift_config
        object
        connection_id
        integer (int64)

        Redshift接続情報ID

        query
        string

        クエリ

        database
        string

        データベース

        variables
        Array of string

        カスタム変数

        string
        snowflake_config
        object
        connection_id
        integer (int64)

        Snowflake接続情報ID

        query
        string

        クエリ

        warehouse
        string

        ウェアハウス

        variables
        Array of string

        カスタム変数

        string
        string_config
        object
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        values
        Array of string

        カスタム変数値

        string
        trocco_azure_synapse_analytics_datamart
        object
        definition_id
        integer (int64)

        Azure Synapse Analyticsデータマート定義ID

        custom_variable_loop
        Array of object

        カスタム変数ループ設定

        object
        type
        string

        カスタム変数ループ種別

        Valid values[ "bigquery", "period", "redshift", "snowflake", "string" ]
        bigquery_config
        object
        connection_id
        integer (int64)

        Bigquery接続情報ID

        query
        string

        クエリ

        variables
        Array of string

        カスタム変数

        string
        period_config
        object
        interval
        string

        ループ間隔

        time_zone
        string

        タイムゾーン

        from
        object

        ループ開始タイミング

        value
        integer

        ループ開始タイミング値

        unit
        string

        ループ開始タイミング単位

        Valid values[ "date", "month", "year" ]
        to
        object

        ループ終了タイミング

        value
        integer

        ループ終了タイミング値

        unit
        string

        ループ終了タイミング

        Valid values[ "date", "month", "year" ]
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        offset
        object

        展開される値

        value
        integer

        展開される値

        unit
        string

        展開される値の単位

        Valid values[ "date_ago", "date_later", "month_ago", "month_later", "year_ago", "year_later" ]
        redshift_config
        object
        connection_id
        integer (int64)

        Redshift接続情報ID

        query
        string

        クエリ

        database
        string

        データベース

        variables
        Array of string

        カスタム変数

        string
        snowflake_config
        object
        connection_id
        integer (int64)

        Snowflake接続情報ID

        query
        string

        クエリ

        warehouse
        string

        ウェアハウス

        variables
        Array of string

        カスタム変数

        string
        string_config
        object
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        values
        Array of string

        カスタム変数値

        string
        trocco_transfer_bulk_config
        object
        definition_id
        integer (int64)

        マネージド転送設定ID

        trocco_transfer_config
        object
        definition_id
        integer (int64)

        転送設定ID

        custom_variable_loop
        Array of object

        カスタム変数ループ設定

        object
        type
        string

        カスタム変数ループ種別

        Valid values[ "bigquery", "period", "redshift", "snowflake", "string" ]
        bigquery_config
        object
        connection_id
        integer (int64)

        Bigquery接続情報ID

        query
        string

        クエリ

        variables
        Array of string

        カスタム変数

        string
        period_config
        object
        interval
        string

        ループ間隔

        time_zone
        string

        タイムゾーン

        from
        object

        ループ開始タイミング

        value
        integer

        ループ開始タイミング値

        unit
        string

        ループ開始タイミング単位

        Valid values[ "date", "month", "year" ]
        to
        object

        ループ終了タイミング

        value
        integer

        ループ終了タイミング値

        unit
        string

        ループ終了タイミング

        Valid values[ "date", "month", "year" ]
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        offset
        object

        展開される値

        value
        integer

        展開される値

        unit
        string

        展開される値の単位

        Valid values[ "date_ago", "date_later", "month_ago", "month_later", "year_ago", "year_later" ]
        redshift_config
        object
        connection_id
        integer (int64)

        Redshift接続情報ID

        query
        string

        クエリ

        database
        string

        データベース

        variables
        Array of string

        カスタム変数

        string
        snowflake_config
        object
        connection_id
        integer (int64)

        Snowflake接続情報ID

        query
        string

        クエリ

        warehouse
        string

        ウェアハウス

        variables
        Array of string

        カスタム変数

        string
        string_config
        object
        variables
        Array of object

        カスタム変数

        object
        name
        string

        カスタム変数名

        values
        Array of string

        カスタム変数値

        string
        task_dependencies
        Array of object | null

        ワークフロータスク間の依存関係

        object
        source
        string

        依存元タスクキー

        destination
        string

        依存先タスクキー

        401

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

        403

        権限がありません。

        404

        指定したワークフローが存在しません。

        Was this article helpful?
        What's Next