Scheduler Service
Create a schedule

1min
POST
/schedules
Header Parameters
X-COREOS-ACCESS
string
*
X-COREOS-APPID
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
Body Parameters
body
CreateScheduleRequest
*
endpointUrl
string
*
signatureKey
string
*
payload
object
startDate
string
*
endDate
string
cron
string
*
Responses
201
Successful operation
ScheduleResponse
schedule
object
*
error
object
*
400
Bad Request
ScheduleErrorResponse
Example
{"schedule":{},"error":{"code":"200140014002","description":"Bad Request","additionalInfo":"X-COREOS-TID not found in header"}}
schedule
object
*
error
object
*
Curl
JS
Ruby
Python
curl --location '/schedules' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "endpointUrl": "",
  "signatureKey": "",
  "startDate": "",
  "cron": ""
}'
curl --location '/schedules' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "endpointUrl": "",
  "signatureKey": "",
  "startDate": "",
  "cron": ""
}'
Responses
201
400
// Successful operation 
{
  "schedule": {
    "scheduleId": "schedule:89d03717-b21f-49bc-b3c9-cd1924cee5a2",
    "tenantId": "os1decs",
    "appId": "dispatch-fpa",
    "endpointUrl": "https://example.com/trigger",
    "signatureKey": "abcdefghijklmnopqrstuvwxyz0123456789",
    "payload": {},
    "startDate": "2023-08-30",
    "endDate": "2023-08-30",
    "cron": "* * * * *",
    "isActive": true
  },
  "error": {}
}
// Successful operation 
{
  "schedule": {
    "scheduleId": "schedule:89d03717-b21f-49bc-b3c9-cd1924cee5a2",
    "tenantId": "os1decs",
    "appId": "dispatch-fpa",
    "endpointUrl": "https://example.com/trigger",
    "signatureKey": "abcdefghijklmnopqrstuvwxyz0123456789",
    "payload": {},
    "startDate": "2023-08-30",
    "endDate": "2023-08-30",
    "cron": "* * * * *",
    "isActive": true
  },
  "error": {}
}
﻿
﻿
Updated 20 Sep 2024
Did this page help you?
Aggregate Query API
List schedules