Scheduler REST Endpoints
Scheduler
- Cancel the callback subscription for the given request
- Method: deletePath:
ess/rest/scheduler/v1/requests/{requestId}/subscribe
- Describe the scheduler API
- Method: getPath:
ess/rest/scheduler/v1
- Information about a job request
- Method: getPath:
ess/rest/scheduler/v1/requests/{requestId}
- Information about the permissions of the current user on this job request
- Method: getPath:
ess/rest/scheduler/v1/requests/{requestId}/permissions
- Initiate a cancel operation for the job request
- Method: postPath:
ess/rest/scheduler/v1/requests/{requestId}/cancel
- Initiate a force cancel operation for the job request
- Method: postPath:
ess/rest/scheduler/v1/requests/{requestId}/forceCancel
- Initiate a hold operation for the job request
- Method: postPath:
ess/rest/scheduler/v1/requests/{requestId}/hold
- Initiate a release operation for the job request
- Method: postPath:
ess/rest/scheduler/v1/requests/{requestId}/release
- Mark a submitted request as deleted
- Method: deletePath:
ess/rest/scheduler/v1/requests/{requestId}
- Query job requests
- Method: getPath:
ess/rest/scheduler/v1/requests
- Query job requests with pageIndex
- Method: getPath:
ess/rest/scheduler/v1/requests/search/{pageIndex}
- Registers the callback URL.
- Method: postPath:
ess/rest/scheduler/v1/requests/{requestId}/subscribe
- Set the status of the request execution
- Method: postPath:
ess/rest/scheduler/v1/requests/{requestId}/executionStatus
- Submit a new job request
- Method: postPath:
ess/rest/scheduler/v1/requests
- Update the scheduler request
- Method: patchPath:
ess/rest/scheduler/v1/requests/{requestId}