REST API for GoldenGate Veridata

Schedule Jobs

post

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

Required Role: Administrator, SuperUser, CommandLineOperator, JobOperator, RepairOperator

Schedule Veridata Jobs.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

scheduleDetails: array scheduleDetails
type(required): string

Default Value: COMPARE

Allowed Values: [ "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
                }
            }
        ]
    }
}

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
            }
        }
    ]
}

Nested Schema : scheduleDetails

Type: array

Show Source

Array of: object ScheduleDetail

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

Nested Schema : ScheduleDetail

Type: object

Show Source

endDate: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

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

Generic object that can contain any number of attributes with any data types (e.g., string, number, boolean, array, object).
schedulePattern(required): 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"
    ]
}

Nested Schema : params

Type: object

Generic object that can contain any number of attributes with any data types (e.g., string, number, boolean, array, object).

Response

Supported Media Types

application/json

201 Response

Successfully scheduled Veridata jobs

Root Schema : ScheduledJobsResponse

Type: object

Show Source

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"
            }
        ]
    }
}

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"
        }
    ]
}

Nested Schema : jobsNotScheduled

Type: array

Show Source

Array of: object items

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

Nested Schema : jobsScheduled

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Nested Schema : items

Type: object

207 Response

Some Veridata jobs were successfully scheduled, while others failed to get scheduled.

Root Schema : ScheduledJobsResponse

Type: object

Show Source

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"
            }
        ]
    }
}

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"
        }
    ]
}

Nested Schema : jobsNotScheduled

Type: array

Show Source

Array of: object items

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

Nested Schema : jobsScheduled

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Nested Schema : items

Type: object

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

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

Example:

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

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

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

Example:

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

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

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

Example:

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

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

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

Example:

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