Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
w) Scheduled Jobs

Create a scheduled job

Creates a new recurring job that will execute on the specified cron schedule. The job type determines which additional fields are required and what the job will do when it fires.

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

Path parameters

tenantIdinteger required

Request body

cronstring required

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

externalUniqueIdstring required

A globally unique identifier for scheduled job

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