Orchestrator Schedules
Note: The nsfilter (namespace filter) query parameter is mandatory for every request. It sets the context, helping you look up resources within that namespace. Example: GET /datasourcesvc/api/v1/orchschedules?nsfilter=proj_DrZrSNrW
Get All Orchestrator Schedules
Endpoints
GET /datasourcesvc/api/v1/orchschedules
Request
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
id | String | Pass the Orchestrator's id. | Required |
Query parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
nsfilter | String | The project's namespace. | Required |
Response
Response codes
| Code | Description |
|---|---|
200 | Success |
404 | File Not Found |
Response data example
[
{
"_id": "1eedf5bc-d1f7-4432-9063-c76f84967eb0",
"next_scheduled_time": "1606890210090",
"runinterval": "* * 30",
"next_scheduled_run_created": true
}
]
Get Orchestrator Schedules by Id
Endpoints
GET /datasourcesvc/api/v1/orchschedules/{id}
Request
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
id | String | Pass the Orchestrator Schedule's id. | Required |
Query parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
nsfilter | String | The project's namespace. | Required |
Response
Response codes
| Code | Description |
|---|---|
200 | Success |
404 | File Not Found |
Response data example
{
"_id": "1eedf5bc-d1f7-4432-9063-c76f84967eb0",
"next_scheduled_time": "1606890210090",
"runinterval": "* * 30",
"next_scheduled_run_created": false
}
Create Orchestrator Schedules
Endpoints
POST /datasourcesvc/api/v1/orchschedules
Request
Query parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
nsfilter | String | The project's namespace. | Required |
Body parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
_orchid | String | The Orchestrator's id | Required |
runinterval | String | Run interval scheduling pattern to schedule the Orchestrator | Required |
_actualParams | Object | Actual params of the Orchestrator Schedule. | Optional |
{
"_orchid":"b07990cf-c64d-4cc4-a0bc-02a4daf0510d",
"runinterval":"* * 30"
}
Response
Response codes
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
Response data example
{
"_id": "1eedf5bc-d1f7-4432-9063-c76f84967eb0",
"next_scheduled_time": 1606889548371,
"runinterval": "* * 30",
"next_scheduled_run_created": false
}
Edit an Orchestrator Schedule
Endpoints
PUT /datasourcesvc/api/v1/orchschedules/{id}
Request
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
id | String | Pass the Orchestrator Schedule's id. | Required |
Query parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
nsfilter | String | The project's namespace. | Required |
Body parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
runinterval | String | Run interval scheduling pattern to schedule the Orchestrator | Required |
next_scheduled_run_created | Boolean | Optional | |
_actualParams | Object | Actual params of the Orchestrator Schedule. | Optional |
Body example
{
"runinterval": "* * 50"
}
Response
Response codes
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
404 | File Not Found |
Response data example
{
"_id": "8076373b-5659-4ced-b57a-665534703d5c",
"next_scheduled_time": "1606993731492",
"runinterval": "* * 50",
"next_scheduled_run_created": true
}
Delete an Orchestrator Schedule
Endpoints
DELETE /datasourcesvc/api/v1/orchschedules/{id}
Request
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
id | String | Pass the Orchestrator Schedule's id. | Required |
Query parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
nsfilter | String | The project's namespace. | Required |
Response
Response Codes
| Code | Description |
|---|---|
204 | No Content |
404 | File Not Found |
Response data example
None