Overview
To ensure consistent performance and reliability across all environments, CMiC APIs enforce a global batch size limit on all requests that include a batch payload.
Batch Size Limit
Effective Nexus 2, all requests with a batch payload are subject to a maximum batch size of 1,000 records per request. This limit applies to:
- POST - batch insert/create operations
- PATCH - partial update operations
- DELETE - bulk delete operations with a request body
NOTE: Header and detail build requests are submitted together in a single call (the header record and all associated detail records count collectively toward the 1,000-record limit).
Requests exceeding this limit will return a 413 Content Too Large error. The response will include a message indicating the batch size has been exceeded and the maximum allowed.
Example:
413 Content Too Large {Batch size exceeded, maximum is 1000}
Affected Endpoints
This limit applies to all CMiC REST API endpoints that accept batch payloads. Examples include:
- JC Transactions
- PY E-timesheets
- Crew Employee Timesheets
- Crew Equipment Timesheets
- Crew Member Assignment
- AP Manual Check with Extension
Recommended Approach
If your integration submits more than 1,000 records in a single operation, split the payload across multiple sequential requests. When constructing header and detail requests, account for the combined record count across both the header and its associated detail lines.
For example, a request containing one header record and 999 detail records equals 1,000 records and is within the limit. A request containing one header and 1,000 detail records equals 1,001 records and will be rejected.
Native Batch Requests — Known Limitations
While ADF BC REST supports batch requests via application/vnd.oracle.adf.batch+json, consider the following before building against this pattern:
- Performance: Native batch processing is significantly slower than CMiC's purpose-built batch endpoints.
- Response Reliability: The created record is not guaranteed to be returned in the response. Behavior varies by endpoint implementation.
Recommendation: Where a dedicated CMiC batch endpoint exists for your resource, use it. If one doesn't exist for your use case, contact CMiC Support or your Account Manager for more information on its enablement.