API

Create a scheduled jobs

post
https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants//scheduled-jobs
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
Body Params
additionalFields
array of objects
additionalFields
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.

string

The cron timezone specifying timezone for cron expression.

string
length between 2 and 2000

Description of scheduled job

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

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

int64
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

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago