Contents x
    転送ジョブ一覧取得
      • Print
      • PDF
      Contents

      転送ジョブ一覧取得

        • Print
        • PDF
        Article summary

        Get
        /api/job_definitions/{job_definition_id}/jobs

        転送設定を指定して転送ジョブの一覧を取得します。

        Security
        API Key
        Header parameter nameAuthorization

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

        Path parameters
        job_definition_id
        integer (int64) Required

        転送設定IDを指定します。
        trocco画面からIDを確認する場合は、各種IDの確認方法を参照ください。


        Example123
        Query parameters
        start_time
        string

        期間絞り込みの開始日時を指定します。
        対象日時は転送ジョブ作成日時です。タイムゾーンにはtime_zoneの値が使用されます。


        Example2020-01-01 00:00:00
        end_time
        string

        期間絞り込みの終了日時を指定します。
        対象日時は転送ジョブ作成日時です。タイムゾーンにはtime_zoneの値が使用されます。


        Example2020-01-01 12:00:00
        time_zone
        string

        タイムゾーンを指定します。
        start_timeとend_timeで指定する日時に適用されます。指定できる値は、タイムゾーンについてを参照ください。


        Default"Asia/Tokyo"
        ExampleEtc/UTC
        limit
        integer (int64) 

        取得する転送ジョブの最大件数を指定します。


        Maximum100
        Default"50"
        Example50
        cursor
        string

        取得する転送ジョブ一覧の最初のレコードを示すページネーションカーソルを指定します。
        レスポンスに含まれるnext_cursorをセットすると、後続の転送ジョブ一覧を取得できます。



        Responses
        200

        転送ジョブの一覧を返します。

        Expand All
        object 
        items
        Array of object 
        object 
        id
        integer (int64) 

        転送ジョブIDです。

        Example123
        status
        string 

        転送ジョブのステータスです。

        • queued - 実行待機
        • setting_up - 実行準備
        • executing - 実行中
        • interrupting - 実行中断
        • succeeded - 実行完了（成功）
        • error - 実行完了（エラー）
        • canceled - 実行完了（キャンセル）
        • skipped - 実行完了（スキップ）
        • timeout - 実行完了（タイムアウト）
        Valid values[ "queued", "setting_up", "executing", "interrupting", "succeeded", "error", "canceled", "skipped", "timeout" ]
        Exampleexecuting
        transfer_record
        integer (int64) 

        転送ジョブにより転送されたレコード数です。

        Example100
        transfer_byte
        integer (int64) 

        転送ジョブにより転送されたバイト数です。

        Example123456789
        skipped_row_count
        integer (int64) 

        スキップされたレコード数です。

        Example100
        context_time
        string 

        時刻・日付（キューイング時）設定としたカスタム変数の展開日時です。タイムゾーンはJST 日本時間（GMT+9）です。

        Example2023-08-23T03:00:00+09:00
        executor_type
        string 

        転送ジョブ実行タイプです。

        • manual - 転送設定詳細画面、もしくは転送ジョブ詳細画面から実行
        • scheduler - 転送設定のスケジュール実行
        • workflow - ワークフローから実行
        • api - trocco APIから実行
        • job_dependency - 実行トリガーから実行
        Valid values[ "manual", "scheduler", "workflow", "api", "job_dependency" ]
        Examplescheduler
        started_at
        string 

        転送ジョブのステータスが実行中になった日時です。タイムゾーンはJST 日本時間（GMT+9）です。

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

        転送ジョブのステータスが実行完了になった日時です。タイムゾーンはJST 日本時間（GMT+9）です。

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

        転送ジョブの作成日時です。タイムゾーンはJST 日本時間（GMT+9）です。

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

        後続のページネーションリクエストの取得開始レコードを示すカーソル値です。

        400

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

        401

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

        404

        Not found.
        要求したリソースが見つかりません。

        Was this article helpful?
        What's Next