Data Limitations
The optimization modes such as (PS), (PT), and (OTD) are accessed through Optimax scheduling APIs. Uncontrolled API traffic can lead to performance degradation, increased response times, and system downtime.
To control the API usage, the following limits on API are set. This ensures that each API request data sets stay within acceptable limits, keeping execution times acceptable resulting in a positive user experience.
Volume Limitation
The following table describes the limitations.
|
Field
|
Limit
|
Description
|
|---|---|---|
|
Resources
|
500
|
Maximum number of resources allowed per API request.
|
|
Work Orders
|
350
|
Maximum number of work orders allowed per API request.
|
|
Events
|
2000
|
Maximum number of events allowed per API request.
|
|
Horizon
|
365
|
Maximum number of days to allow work to be scheduled for, which translates to the maximum number of working hours per resource.
|
|
Routes
|
500
|
Maximum number of routes to allow for scheduling where routes are the total number of working hours considering all resources.
|
 |
If any of the data set is exceeded, then an error message is displayed. For more information, see Error Codes and Messages.
|
Rate Limitation
The following table describes the limitations.
|
Field
|
Limit
|
Description
|
|
|---|---|---|---|
|
Window
|
60
|
Interval in minutes to apply limit.
|
|
|
Number of jobs allowed
|
Number of jobs allowed
|
100
|
Maximum number of API requests allowed in the configured interval.
|
For example, you can send up to 100 API requests within a 60-minute window. Once the window resets after 60 minutes, you can send the next batch of requests.
|
|
If any of the data set is exceeded, then an error message is displayed. For more information, see Error Codes and Messages.
|