14 Job Admin REST Endpoints
Batch service is a RESTful service that provides various endpoints to manage batch jobs in Job Admin.
The endpoint "discover" can be used to identify all endpoints provided by Job Admin.
| REST Resource | HTTP Method | Description |
|---|---|---|
|
/discover |
GET |
Lists all available endpoints in Job Admin |
|
/batch/jobs |
GET |
Gets all available batch jobs |
|
/batch/jobs/enable-disable |
POST |
Enable or disable jobs |
|
/batch/jobs/{jobName} |
GET |
Gets all instances for a job |
|
/batch/jobs/{jobName}/executions |
GET |
Gets all executions for a job |
|
/batch/jobs/executions |
GET |
Gets all executions |
|
/batch/jobs/currently-running-jobs |
GET |
Gets currently running jobs |
|
/batch/jobs/{jobName}/{jobInstanceId}/executions |
GET |
Gets job executions for a job instance |
|
/batch/jobs/{jobName}/{jobExecutionId} |
GET |
Gets job instance and execution for a job execution id |
|
/batch/jobs/{jobName} |
POST |
Starts a job asynchronously |
|
/batch/jobs/executions/{jobExecutionId} |
POST |
Restarts a stopped or failed job |
|
/batch/jobs/executions |
DELETE |
Stops all running job executions |
|
/batch/jobs/executions/{jobExecutionId} |
DELETE |
Stops a job execution |
|
/batch/jobs/executions/{jobExecutionId} |
GET |
Gets execution steps with details |
|
/batch/jobs/executions/{jobExecutionId}/steps |
GET |
Gets execution steps |
|
/batch/jobs/executions/{jobExecutionId}/steps/{stepExecutionId} |
GET |
Gets step details |
|
/batch/jobs/job-def-xml-files |
GET |
Gets all job xml files |
|
/batch/jobs/is-job-ready-to-start/{jobName} |
GET |
Is job ready to start for a given job name |
|
/batch/jobs/group-definitions |
GET |
Gets group definitions |
|
/batch/jobs/job-def-xml/{jobXmlId} |
POST |
|
|
/telemetry/jobs |
GET |
Returns runtime job metrics between fromTime and toTime |
|
/manage-group/group |
PUT |
Update a group |
|
/manage-group/group |
POST |
Add a group |
|
/manage-group/group/{groupId} |
DELETE |
Delete a group for a given groupId |
|
/manage-group/group/{groupId} |
GET |
Gets group info for a given groupId |
|
/manage-group/group/name/{groupName} |
DELETE |
Delete group info for a given group name |
|
/manage-group/group/name/{groupName} |
GET |
Gets group info for a given group name |
|
/manage-group/group/group-members |
PUT |
Update group members info |
|
/manage-group/group/group-member |
PUT |
Update group member info |
|
/manage-group/group/group-member |
POST |
Add a group member |
|
/manage-group/group/{groupName}/group-member/{groupMemberName} |
DELETE |
Delete group member for a given group name and group member name |
|
/manage-group/group/{groupName}/group-members |
GET |
Gets group members for a given group name |
|
/manage-group/group/group-member/{groupMemberId} |
GET |
Gets group member info for a given group memberId |
|
/manage-group/group/group-members/{memberName}/{memberType} |
GET |
Gets group members for a given member name and memberType |
|
/manage-group/groups |
GET |
Gets all groups |
|
/manage-group/groups |
PUT |
Updates all groups |
|
/manage-group/groups |
POST |
Creates multiple groups specified in request with single request. |
|
/manage-group/group/{groupName}/group-members |
POST |
Adds multiple members to a given groups at a time. |
|
/manage-group/group/{groupName}/group-members |
DELETE |
Deletes all members from given group at once. |
|
/manage-group/groups |
DELETE |
Deletes multiple groups at once |
|
batch/jobs/job-def-xml/{jobName} |
PUT |
Creates an entry in BDI_JOB_DEFINITION table. It will throw an exception if job already exists. |
|
batch/jobs/job-def-xml/{jobName} |
POST |
Updates an entry in BDI_JOB_DEFINITION table. It will update if job is not in running state. This end point throws an exception if job doesn't exist in the table |
|
batch/jobs/job-def-xml/{jobName} |
DELETE |
Deletes an entry in BDI_JOB_DEFINITION table. It will delete if job is not in running state and if there is no history in batch database. |
|
batch/jobs/{jobName} |
DELETE |
Deletes history for a job from batch database. It will delete history if job is not in running state. |
|
/batch/jobs/bulk/job-definitions |
POST |
End point for bulk create/update job definitions |
|
/batch/jobs/bulk/job-definitions |
DELETE |
End point for bulk delete job definitions |