API Limiting Coming Soon

The Kuali Research suite APIs are being updated to include limits on the maximum number of results they return, as well as adding the ability to page through large result sets. To maintain compatibility with existing integrations, the response format will not be changing to accomodate the addition of paging but new response headers will be added to indicate the caller's position in the result set:

• X-Kuali-Paging-Start-Index: The current index of the results being returned.
• X-Kuali-Paging-Limit: The upper limit on the number of results returned.
• X-Kuali-Paging-Total: The total number of results in the entire result set.

All GET MULTIPLE APIs will also be updated to accept the following query parameters to support paging through the result set:

• _startIndex: The first index of the result set to be retrieved (starting at 0).
• _limit: The number of results to return. Defaults to the limit defined by the REST_ENDPOINT_LIMIT_DEFAULT parameter.

Starting October 19, 2020, all GET MULTIPLE APIs will be updated to return a maximum of 500 results which could be a breaking change for any integrations relying on retrieving large sets of data in one request. Such integrations will need to be updated to page through results over multiple requests. We recommend updating the REST_ENDPOINT_LIMIT_DEFAULT parameter to 500 in a staging or sandbox environment prior to October 19 and testing any affected integrations there to ensure they still function as expected.

The change on October 19 will apply to the following API endpoints:

• /award/api/v1/...
• /research-common/api/v1/...
• /instprop/api/v1/...
• /negotiation/api/v1/...
• /propdev/api/v1/...
• /subaward/api/v1/...
• /research-sys/api/v1/...

It will not apply to the following endpoints, although they are likely to be updated to match soon after October 19:

• /award/api/v2/...
• /award/api/v1/accounts/...
• /award/api/v1/time-and-money...
• /research-common/api/v1/person-training-modules/...
• /instprop/api/v1/institutional-proposal-document/...
• /instprop/api/v1/institutional-proposal-person-ordering-report/...
• /propdev/api/v2/...
• All Protocols and COI api endpoints

If you have any questions on the above please submit a support ticket.