Contents x
    データマートシンクジョブ実行
      • Print
      • PDF
      Contents

      データマートシンクジョブ実行

        • Print
        • PDF
        Article summary

        Post
        /api/datamart_jobs

        データマートシンクジョブを実行します。

        Security
        API Key
        Header parameter nameAuthorization

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

        Body parameters
        Expand All
        object
        datamart_definition_id
        integer (int64) Required

        シンクジョブを実行するデータマート定義のID

        Example42
        context_time
        string

        転送設定でカスタム変数 時刻・日付（キューイング時） を利用する場合、展開される日時を指定します。
        未指定の場合、APIリクエストが送信された日時が展開されます。タイムゾーンにはtime_zoneの値が使用されます。
        custom_variablesが指定された場合は無視されます。

        Example2023-05-19 00:00:00
        time_zone
        string

        タイムゾーンを指定します。
        context_timeで指定する日時に適用されます。指定できる値は、タイムゾーンについてを参照ください。
        context_timeが指定されなかった場合は無視されます。

        Default"Asia/Tokyo"
        ExampleEtc/UTC
        memo
        string

        任意のテキストを指定します。

        Example実行したシンクジョブに関する補足など〜
        custom_variables
        Array of object
        object
        name
        string

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

        Example$companyId$
        value
        string

        直前に指定したカスタム変数に展開する値を指定します。
        複数のカスタム変数を指定することができます。

        Examplec-12345
        Responses
        200

        実行したデータマートシンクジョブの情報を返却します。

        object
        id
        integer (int64)

        データマートシンクジョブIDです。

        Example123
        datamart_definition_id
        integer (int64)

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

        Example321
        context_time
        string

        転送設定でカスタム変数 時刻・日付（キューイング時） を利用した場合に展開された日時を指定します。
        リクエスト時にcontext_timeを指定した場合、その値が返却されます。

        Example2023-05-19 00:00:00
        400

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

        401

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

        Was this article helpful?
        What's Next