Contents x
    転送設定一覧取得
      • Print
      • PDF
      Contents

      転送設定一覧取得

        • Print
        • PDF
        Article summary

        Get
        /api/job_definitions

        転送設定の一覧を取得します。

        Security
        API Key: ApiKeyAuth
        Header parameter nameAuthorization

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

        Query parameters
        name
        string

        転送設定名で絞り込みます。部分一致検索です。

        Examplesample
        limit
        integer (int64)

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

        Maximum100
        Default50
        Example50
        cursor
        string

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

        Responses
        200

        転送設定の一覧を返します。

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

        転送設定ID

        name
        string

        転送設定名

        description
        string | null

        転送設定メモ

        input_option_type
        string

        転送元の種別

        Valid values[ "salesforce", "mysql", "gcs", "snowflake", "postgresql", "bigquery", "kintone", "yahoo_ads_api_yss", "google_spreadsheets", "s3", "google_analytics4", "kintone", "http" ]
        output_option_type
        string

        転送先の種別

        Valid values[ "bigquery", "snowflake", "salesforce", "google_spreadsheets", "google_ads_customer_match" ]
        created_at
        string (date-time)

        作成日時

        updated_at
        string (date-time)

        更新日時

        resource_group_id
        integer | null

        リソースグループID。リソースグループに追加すると、他のユーザーに設定を共有できるようになります。

        labels
        Array of string | null

        ラベル設定を指定します。

        Min items0
        Max items40
        string

        ラベル名を指定します。

        schedules
        Array of object | null

        スケジュール設定を指定します。

        Min items0
        Max items10
        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
        notifications
        Array of object | null

        通知設定を指定します。

        Min items0
        Max items20
        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: レコード条件(超過/過不足)通知
        exec_time: 実行時間経過通知

        Valid values[ "job", "record", "time" ]
        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" ]
        record_type

        通知するレコード数条件
        recordタイプのとき必須
        transfer: 転送した
        skipped: スキップされた

        created_by
        object | null

        作成者情報

        id
        integer (int64)

        ユーザーID

        email
        string

        ユーザーメールアドレス

        next_cursor
        string

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

        400

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

        401

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

        Was this article helpful?
        What's Next