Retrieve All Batch Groups

This operation returns all batch groups.

The associated Access Control Point is as follows:

  • ACP Key: BATCH_GROUPS

  • API Access Controlled By: View - Allowed or Edit - Allowed

  • Default Values: View - Disallowed, Edit - Disallowed

  • Location in the UI: Location: Manager - Common Setup > Batch Processing

Service limit

A service limit constrains the number of batch groups that can be processed in a single request.

  • The Number of Batch Groups cannot exceed 999.

Note: If your system has more than 999 batch groups, set the all_details Boolean to false to return an unlimited number of batch group references, which include the name (qualifier) and ID. When true, you can use this operation to return the full details of all batch groups up to a total of 999.

Refer to the Limits topic for more information.

Language
Credentials
Bearer
JWT
URL