Create a scheduled job

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/scheduled-jobs

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

Body Params

Scheduled job Type

additionalFields

array of objects

additionalFields

cron

string

required

length between 2 and 50

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

cronTimezone

string

The cron timezone specifying timezone for cron expression.

description

string

length between 2 and 2000

(?s)^(?:[\t\r\n]|[^\p{C}<>])*$

Description of scheduled job

endDate

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

externalUniqueId

string

required

length between 2 and 100

A globally unique identifier for scheduled job

relatedTo

array of objects

It is utilized to associate scheduled job with specific objects or entities such as customer, organisation, or wallet. For instance, a withdrawal might be linked to a walletId, while a recurring payment could be associated with a customerId. Additionally, it facilitates searching for jobs based on the related attributes

relatedTo

startDate

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

tenantId

int64

type

string

enum

This defines the nature of scheduled jobs, currently supporting two types: RECURRING_WITHDRAWAL, likely for regular withdrawals of specific amounts, and RECURRING_PAYMENT, for recurrent payments of specified amounts. The behavior of ScheduledJobType heavily relies on the provided additional fields

Allowed:

Responses

400

Bad Request

200OK

500Internal Server Error