All URIs are relative to **
| Method | HTTP request | Description |
|---|---|---|
| schedulerServiceCreateScheduledJob | POST /api/v3/schedules | Summary: Create scheduled job |
| Description: Create a new scheduled job with tasks. | ||
| schedulerServiceDeleteScheduledJob | DELETE /api/v3/schedules/{schedule_id} | Summary: Delete scheduled job |
| Description: Delete a single scheduled job. | ||
| schedulerServiceGetDependencies | GET /api/v3/schedules/dependencies | Summary: Get dependencies |
| Description: returns IDs of distribution rules, response templates, or processing rules that are in use | ||
| schedulerServiceGetDistributionRules | GET /api/v3/schedules/distribution_rules | Summary: Get distribution rules |
| Description: Return a list of distribution rule IDs that are used by the scheduler | ||
| Distribution rules can't be edited if it is used by a scheduled job. | ||
| schedulerServiceGetScheduledJobDetails | GET /api/v3/schedules/{schedule_id}/details | Summary: Get scheduled job |
| Description: Return a single ScheduledJob in detail. | ||
| schedulerServiceGetScheduledJobs | GET /api/v3/schedules | Summary: Get scheduled jobs |
| Description: Return a list of scheduled jobs and the linked tasks. | ||
| schedulerServiceGetSchedulesByReport | POST /api/v3/schedules/searchByReport/{report_id} | Summary: Get schedules by report |
| Description: Return an array of scheduled job IDs that run the report_id. An empty array is returned if the report_id is not scheduled. | ||
| schedulerServiceGetTags | GET /api/v3/schedules/tags | Summary: Get tags |
| Description: Return an array of all the unique tags from scheduled jobs. | ||
| schedulerServiceSearchScheduledJobs | POST /api/v3/schedules/search | Summary: Search scheduled jobs |
| Description: Return a filtered list of scheduled jobs and the linked tasks. | ||
| schedulerServiceSearchScheduledTaskRuns | POST /api/v3/schedules/runs/search | Summary: Search scheduled task runs |
| Description: Return a list of scheduled task run, start date, end date, status | ||
| schedulerServiceUpdateScheduledJob | PATCH /api/v3/schedules/{schedule_id} | Summary: Update scheduled job |
| Description: Update a single schedule job. |
Summary: Create scheduled job Description: Create a new scheduled job with tasks.
schedulerServiceCreateScheduledJob| Name | Type | Description | Notes |
|---|---|---|---|
| schedulerv3CreateScheduledJobRequest | Schedulerv3CreateScheduledJobRequest |
Schedulerv3CreateScheduledJobResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Delete scheduled job Description: Delete a single scheduled job.
schedulerServiceDeleteScheduledJob schedule_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| scheduleId | string | Unique ID, required for delete. | [default to null] |
Schedulerv3DeleteScheduledJobResponse
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Get dependencies Description: returns IDs of distribution rules, response templates, or processing rules that are in use
schedulerServiceGetDependencies config_type=value| Name | Type | Description | Notes |
|---|---|---|---|
| configType | string | specify the configuration entry type: Distribution.Rule, workflow_investigation_link, workflow_response_template, etc. | [optional] [default to null] |
Schedulerv3GetDependenciesResponse
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Get distribution rules Description: Return a list of distribution rule IDs that are used by the scheduler Distribution rules can't be edited if it is used by a scheduled job.
schedulerServiceGetDistributionRulesThis endpoint does not need any parameter.
Schedulerv3GetDistributionRulesResponse
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Get scheduled job Description: Return a single ScheduledJob in detail.
schedulerServiceGetScheduledJobDetails schedule_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| scheduleId | string | Used to return a single scheduledjob. | [default to null] |
Schedulerv3GetScheduledJobResponse
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Get scheduled jobs Description: Return a list of scheduled jobs and the linked tasks.
schedulerServiceGetScheduledJobs Offset=value Limit=value| Name | Type | Description | Notes |
|---|---|---|---|
| offset | integer | Optional: the amount to offset the rows by for pagination. | [optional] [default to null] |
| limit | integer | Optional: the max amount of rows to return for pagination. | [optional] [default to null] |
Schedulerv3ScheduledJobSummaryResponse
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Get schedules by report Description: Return an array of scheduled job IDs that run the report_id. An empty array is returned if the report_id is not scheduled.
schedulerServiceGetSchedulesByReport report_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| reportId | string | Report ID for the scheduled report. | [default to null] |
| schedulerv3GetSchedulesByReportRequest | Schedulerv3GetSchedulesByReportRequest |
Schedulerv3GetSchedulesByReportResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Get tags Description: Return an array of all the unique tags from scheduled jobs.
schedulerServiceGetTagsThis endpoint does not need any parameter.
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Search scheduled jobs Description: Return a filtered list of scheduled jobs and the linked tasks.
schedulerServiceSearchScheduledJobs| Name | Type | Description | Notes |
|---|---|---|---|
| schedulerv3SearchScheduledJobsRequest | Schedulerv3SearchScheduledJobsRequest |
Schedulerv3ScheduledJobSummaryResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Search scheduled task runs Description: Return a list of scheduled task run, start date, end date, status
schedulerServiceSearchScheduledTaskRuns| Name | Type | Description | Notes |
|---|---|---|---|
| schedulerv3SearchScheduledTaskRunsRequest | Schedulerv3SearchScheduledTaskRunsRequest |
Schedulerv3SearchScheduledTaskRunsResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Summary: Update scheduled job Description: Update a single schedule job.
schedulerServiceUpdateScheduledJob schedule_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| scheduleId | string | Unique ID, required for update. | [default to null] |
| schedulerv3UpdateScheduledJobRequest | Schedulerv3UpdateScheduledJobRequest |
Schedulerv3UpdateScheduledJobResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]