Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
w) Scheduled Jobs

Update scheduled job

Updates the configuration of an existing scheduled job, such as its cron expression or enabled state.

put/eclipse-conductor/rest/v1/tenants/{tenantId}/scheduled-jobs/{scheduledJobId}

Path parameters

tenantIdinteger required
scheduledJobIdinteger required

Request body

cronstring

The cron expression specifying the schedule for the recurring job. This expression follows the standard cron format, allowing complex scheduling patterns.

cronTimezonestring

The cron timezone specifying timezone for cron expression.

descriptionstring

Description of scheduled job

endDatestring date-time

The expiry date and time(ISO 8601 date/time) after which the scheduled job should stop running. If not set, the job will run indefinitely

scheduledJobIdinteger
startDatestring date-time

The start date and time(ISO 8601 date/time) for which the scheduled job should start running. If not set, the job will get start running immmediately

tenantIdinteger
type'BATCH_WITHDRAWAL' | 'RECURRING_PAYMENT' | 'RECURRING_WITHDRAWAL'

Example request

{
  "endDate": "2022-03-10T12:15:50-04:00",
  "startDate": "2022-03-10T12:15:50-04:00"
}

Response

OK

cronstring
cronTimezonestring
descriptionstring
endDatestring date-time
scheduledJobIdinteger

A unique system generated numeric identifier for the scheduledJob

startDatestring date-time
tenantIdinteger
type'BATCH_WITHDRAWAL' | 'RECURRING_PAYMENT' | 'RECURRING_WITHDRAWAL'

Example response

{
  "endDate": "2022-03-10T12:15:50-04:00",
  "startDate": "2022-03-10T12:15:50-04:00"
}