5.9 KiB
\ScheduleApi
All URIs are relative to https://localhost:49618/v1
| Method | HTTP request | Description |
|---|---|---|
| ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC | Post /schedule/check | |
| ScheduleControllerCreateSchedule | Post /schedule/book | |
| ScheduleControllerGetNextSchedule | Get /schedule/next | |
| ScheduleControllerGetPreviousSchedule | Get /schedule/previous | |
| ScheduleControllerGetSchedules | Get /schedule/ |
ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC
ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC(ctx, cron, duration, startDate, stopDate, requirements)
Check for availability of this DC
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| cron | string | Cron syntax | |
| duration | int32 | Duration in seconds | |
| startDate | interface{} | RFC3339 time for startDate | |
| stopDate | interface{} | RFC3339 time for stopDate | |
| requirements | ModelsExecutionRequirementsModel | The object content |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScheduleControllerCreateSchedule
ModelsScheduleInfo ScheduleControllerCreateSchedule(ctx, dcName, workflowName, cron, duration, startDate, stopDate, requirements)
Create schedule for a workflow. It will return some future executions just as information
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| dcName | string | Name of the node (oc-catalog) from where the workflow comes. | |
| workflowName | string | Workflow Name | |
| cron | string | Cron syntax with year. If no year is specified, will use the current | |
| duration | int32 | Duration in seconds | |
| startDate | interface{} | RFC3339 time for startDate | |
| stopDate | interface{} | RFC3339 time for stopDate | |
| requirements | ModelsExecutionRequirementsModel | The object content |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScheduleControllerGetNextSchedule
TimeTime ScheduleControllerGetNextSchedule(ctx, baseDate)
Give a date, get the next date where there are at least on schedule. If no hours specified, will assume 00:00
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| baseDate | interface{} | Base date |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScheduleControllerGetPreviousSchedule
TimeTime ScheduleControllerGetPreviousSchedule(ctx, baseDate)
Give a date, get the previous date where there are at least on schedule. If no hours specified, will assume 00:00
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| baseDate | interface{} | Base date |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScheduleControllerGetSchedules
[]ModelsScheduleDb ScheduleControllerGetSchedules(ctx, startDate, stopDate)
Get a list of next startDates schedules (inclusive). If timezone is not specified, will assume UTC
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| startDate | interface{} | Start date | |
| stopDate | interface{} | End date |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]