BatchAdmin

Provides administrative access to the Batches and Batch executions on a Broker. Methods in class BatchAdmin are listed in the following table:

Method	Method Type	Description
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.
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 the Batch definition.
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-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.
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.
selected-batch-execution-info	POST	Retrieves information about given Batch execution IDs stored on the Broker.
selected-batch-info	POST	Retrieves information about given Batch entry IDs stored on the Broker.
available	GET	Retrieves whether methods are available.
batch	DELETE	Removes the information about a finished or suspended Batch entry.
batch-execution	DELETE	Removes the information about a finished or failed Batch execution.
finished-batch-executions	DELETE	Removes the information about all finished Batch executions on the Broker.
finished-batches	DELETE	Removes the information about all finished Batch entries on the Broker.
resume-batch	PUT	Resumes a suspended Batch entry.
schedule-batch-definitions	GET	Runs the specified Batch definition.
suspend-all-batches	PUT	Suspends all Batch entries running on the Broker.
suspend-batch	PUT	Suspends a scheduled Batch entry.

Did you find this helpful?

Yes No

Subtopics