Scheduler Service
Get a schedule by ID

1min
GET
/schedules/{scheduleId}
Path Parameters
scheduleId
string
*
Header Parameters
X-COREOS-ACCESS
string
*
X-COREOS-APPID
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
Responses
200
Successful operation
GetScheduleResponse
schedule
object
*
error
object
*
400
Bad Request
Curl
JS
Ruby
Python
curl --location --globoff '/schedules/{scheduleId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff '/schedules/{scheduleId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
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": "* * * * *",
    "nextExecution": "2023-09-12T08:40:00Z",
    "isActive": true,
    "TTL": 1695105095
  },
  "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": "* * * * *",
    "nextExecution": "2023-09-12T08:40:00Z",
    "isActive": true,
    "TTL": 1695105095
  },
  "error": {}
}
﻿
﻿
Updated 20 Sep 2024
Did this page help you?
List schedules
Update a schedule