SAP Knowledge Base Article - Public

2489065 - OData API returns 1000 records in the response when more are expected

Symptom

You performed an OData API query and it fetched 1000 records, but you were expecting more results in the response payload.

Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.

Environment

  • SAP SuccessFactors HXM Suite
    • OData API

Resolution

The max records returned in the response of OData API is 1000 per page, as explained in the OData Developer Guide. If more than 1000 results are fetched by the query, then it will create more pages of results.

If you were expecting a specific record to be returned and it didn't return in the first page of the response, this can indicate that the record is actually in some other page of the response.

To get access to the subsequent pages and see the next set of records, you need to use the Skiptoken which is located at the bottom of the response payload. It is a link similar to these ones below:

  1. On XML format:
    <link rel="next" href="https://apisalesdemo4.successfactors.com:443/odata/v2/User?$select=userId,status%20%20%20&amp;$skiptoken=eyJzdGFydFJvdyI6MTAwMCwiZW5kUm93IjoyMDAwfQ=="></link>

  2. On JSON format:
    "__next": "https://apisalesdemo4.successfactors.com:443/odata/v2/User?$select=userId,status&$format=json&$skiptoken=eyJzdGFydFJvdyI6MTAwMCwiZW5kUm93IjoyMDAwfQ=="

If you use the URL contained within the "__next" field, it will take you to the next page of records.

Note: if needed, you are able to decrease the number of records returned in the response pages (which by default is 1000) using the Custom Page Size parameter - this is helpful in cases where your process may be facing issues related to performance.

See Also

SAP SuccessFactors HXM Suite OData API: Developer Guide

Keywords

API, 1000, 1000 Records, Missing Data, odata, successfactors, success factors, sf, skiptoken, skip token, __next, next, pagination, page size, pagesize, custom, missing records, record, result, payload, response, query, expected record, expecting , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , Integrations , Problem

Product

SAP SuccessFactors HXM Suite all versions