Batch Admin
Provides administrative access to the Batches and Batch executions on a Broker. The methods in class Batch Admin are listed in the following table.
| Method | Method Type | Description |
|---|---|---|
| available | GET | Retrieves whether methods are available. Returns true if the method is available and false if the method is not available. |
| all-batch-execution-info | GET | Retrieves all the Batch execution information stored on the Broker. |
| all-batch-info | GET | Retrieves information about all the Batch entries on the Broker. |
| batch-count | GET | Retrieves the total number of Batch entries stored on the Broker. |
| batch-definition | GET | Retrieves XML contents of a Batch definition. |
| batch-definition | POST | Stores the XML contents to a Batch definition on the Broker. |
| batch-definition | DELETE | Removes a Batch definition stored on the Broker. |
| batch-definition-names | GET | Retrieves the Batch definition names stored on the Broker. |
| batch-execution-count | GET | Retrieves the total number of Batch executions stored on the Broker. |
| batch-execution-ids | GET | Retrieves the list of Batch execution IDs stored on the Broker. |
| batch-execution-info | GET | Retrieves information about a given Batch execution ID stored on the Broker. |
| batch-execution-info-by-batch-id | GET | Retrieves all the Batch execution information about a given Batch entry stored on the Manager. |
| batch-execution | DELETE | Removes the information about a finished or failed Batch execution. |
| batch-ids | GET | Retrieves the list of Batch entry IDs stored on the Broker. |
| batch-info | GET | Retrieves the Batch entry information about a given Batch entry ID stored on the Broker. |
| batch | DELETE | Removes the information about a finished or suspended Batch entry. |
| finished-batches | DELETE | Removes the information about all the finished Batch entries on the Broker. |
| finished-batch-executions | DELETE | Removes the information about all the finished Batch executions on the Broker. |
| resume-batch | PUT | Resumes a suspended Batch entry. |
| running-batch-execution-count | GET | Retrieves the total number of running batch executions stored on the Broker. |
| scheduled-batch-count | GET | Retrieves the total number of scheduled Batch entries on the Broker. |
| schedule-batch-definitions | GET | Runs the specified Batch definition. |
| selected-batch-info | POST | Retrieves information about the given Batch entry IDs stored on the Broker. |
| selected-batch-execution-info | POST | Retrieves information about the given Batch execution IDs stored on the Broker. |
| suspend-batch | PUT | Suspends a scheduled Batch entry. |
| suspend-all-batches | PUT | Suspends all Batch entries running on the Broker. |
Related information
REST API Reference
availableall-batch-execution-infoall-batch-infobatch-countbatch-definitionbatch-definitionbatch-definitionbatch-definition-namesbatch-execution-countbatch-execution-idsbatch-execution-infobatch-execution-info-by-batch-idbatch-executionbatch-idsbatch-infobatchfinished-batchesfinished-batch-executionsresume-batchrunning-batch-execution-countscheduled-batch-countschedule-batch-definitionsselected-batch-infoselected-batch-execution-infosuspend-batchsuspend-all-batches