GoldenGate Veridata REST API

ジョブのスケジュール

post

http://{host}:{port}/veridata/v1/services/configuration/schedule/jobs

必要なロール: Administrator、SuperUser、CommandLineOperator、JobOperator、RepairOperator

Veridataジョブをスケジュールします。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされるメディア・タイプ

application/json

ルート・スキーマ: schema

タイプ: object

ソースの表示

scheduleDetails: array scheduleDetails
type(必須): string

デフォルト値: COMPARE

指定できる値: [ "COMPARE" ]

{
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/ScheduleTypeEnum"
        },
        "scheduleDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduleDetail"
            }
        }
    },
    "required":[
        "type"
    ],
    "example":{
        "type":"COMPARE",
        "scheduleDetails":[
            {
                "schedulePattern":"0 * * * * ?",
                "endDate":"2024-02-03T10:15:30Z",
                "params":{
                    "jobId":1001,
                    "isEnabled":true
                }
            },
            {
                "schedulePattern":"0 * * * * ?",
                "endDate":"2024-02-03T10:15:30Z",
                "params":{
                    "jobId":1002,
                    "isEnabled":true
                }
            }
        ]
    }
}

例:

{
    "type":"COMPARE",
    "scheduleDetails":[
        {
            "schedulePattern":"0 * * * * ?",
            "endDate":"2024-02-03T10:15:30Z",
            "params":{
                "jobId":1001,
                "isEnabled":true
            }
        },
        {
            "schedulePattern":"0 * * * * ?",
            "endDate":"2024-02-03T10:15:30Z",
            "params":{
                "jobId":1002,
                "isEnabled":true
            }
        }
    ]
}

ネストされたスキーマ: scheduleDetails

タイプ: array

ソースの表示

配列: object ScheduleDetail

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ScheduleDetail"
    }
}

ネストされたスキーマ: ScheduleDetail

タイプ: object

ソースの表示

endDate: string (date-time)

パターン: YYYY-MM-DDTHH:mm:ss.sssZ

例: 2024-02-03T10:15:30Z
params: object params

任意のデータ型を持つ任意の数の属性(文字列、数値、ブール、配列、オブジェクトなど)を含むことができる汎用オブジェクト。
schedulePattern(必須): string

{
    "type":"object",
    "properties":{
        "schedulePattern":{
            "type":"string"
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "params":{
            "type":"object",
            "description":"Generic object that can contain any number of attributes with any data types (e.g., string, number, boolean, array, object)."
        }
    },
    "required":[
        "schedulePattern"
    ]
}

ネストされたスキーマ: params

タイプ: object

任意のデータ型を持つ任意の数の属性(文字列、数値、ブール、配列、オブジェクトなど)を含むことができる汎用オブジェクト。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

201 レスポンス

Veridataジョブが正常にスケジュールされました

ルート・スキーマ: ScheduledJobsResponse

タイプ: object

ソースの表示

jobsNotScheduled: array jobsNotScheduled
jobsScheduled: array jobsScheduled

{
    "type":"object",
    "properties":{
        "jobsScheduled":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jobsNotScheduled":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "example":{
        "jobsScheduled":[
            {
                "jobId":1001,
                "isEnabled":true
            }
        ],
        "jobsNotScheduled":[
            {
                "jobId":1002,
                "isEnabled":true,
                "errorMessage":"OGGV-01135: Unable to schedule the Job with Job ID 1002 as the Job is already scheduled"
            }
        ]
    }
}

例:

{
    "jobsScheduled":[
        {
            "jobId":1001,
            "isEnabled":true
        }
    ],
    "jobsNotScheduled":[
        {
            "jobId":1002,
            "isEnabled":true,
            "errorMessage":"OGGV-01135: Unable to schedule the Job with Job ID 1002 as the Job is already scheduled"
        }
    ]
}

ネストされたスキーマ: jobsNotScheduled

タイプ: array

ソースの表示

配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

ネストされたスキーマ: jobsScheduled

タイプ: array

ソースの表示

配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

ネストされたスキーマ: items

タイプ: object

ネストされたスキーマ: items

タイプ: object

207レスポンス

一部のVeridataジョブは正常にスケジュールされましたが、他のジョブはスケジュールできませんでした。

ルート・スキーマ: ScheduledJobsResponse

タイプ: object

ソースの表示

jobsNotScheduled: array jobsNotScheduled
jobsScheduled: array jobsScheduled

{
    "type":"object",
    "properties":{
        "jobsScheduled":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jobsNotScheduled":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "example":{
        "jobsScheduled":[
            {
                "jobId":1001,
                "isEnabled":true
            }
        ],
        "jobsNotScheduled":[
            {
                "jobId":1002,
                "isEnabled":true,
                "errorMessage":"OGGV-01135: Unable to schedule the Job with Job ID 1002 as the Job is already scheduled"
            }
        ]
    }
}

例:

{
    "jobsScheduled":[
        {
            "jobId":1001,
            "isEnabled":true
        }
    ],
    "jobsNotScheduled":[
        {
            "jobId":1002,
            "isEnabled":true,
            "errorMessage":"OGGV-01135: Unable to schedule the Job with Job ID 1002 as the Job is already scheduled"
        }
    ]
}

ネストされたスキーマ: jobsNotScheduled

タイプ: array

ソースの表示

配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

ネストされたスキーマ: jobsScheduled

タイプ: array

ソースの表示

配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

ネストされたスキーマ: items

タイプ: object

ネストされたスキーマ: items

タイプ: object

400 レスポンス

不正なリクエスト。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 レスポンス

権限がありません。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 レスポンス

見つかりません。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 レスポンス

サーバー・エラー。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

先頭に戻る