Question

How to retrieve all records from API REST?

  • 27 August 2021
  • 3 replies
  • 974 views

Badge +1

How can I get all the records of a query through the api?
Eliminating the limit of 5000 records.


This topic has been closed for comments

3 replies

Userlevel 7
Badge +31

Hi @franciscoba,

Have you tried specifying $top query parameter in your request URI?

Eg: 

https://<host>:<port>/int/ifsapplications/projection/v1/CustomerOrderLinesHandling.svc/Reference_CustOrdCust1?$top=20

For instance, above will return top 20 records.

You can see available query parameters from API Doc and you can access API Doc via API Explorer window in Aurena. 

 

Hope this helps!

Userlevel 4
Badge +3

Hello @franciscoba ,

 

  1. First, you need to go to the API Explorer window and enable the ' Include in Compatibility Application Type' into 'Yes'  for the relevant API.

 

  1. Then you will be able to open the API Documentation. 
  1. From the documentation, find the handler, and there will be the GET method. 

For more details, you can check the below link.

https://community.ifs.com/framework-experience-infrastructure-cloud-integration-dev-tools-50/restful-api-testing-with-postman-along-with-aurena-10144

 

Hope this will helps you.

 

/Banuka.

Userlevel 7
Badge +31

Hi,

Hello @franciscoba ,

 

  1. First, you need to go to the API Explorer window and enable the ' Include in Compatibility Application Type' into 'Yes'  for the relevant API.

 

  1. Then you will be able to open the API Documentation. 
  1. From the documentation, find the handler, and there will be the GET method. 

For more details, you can check the below link.

https://community.ifs.com/framework-experience-infrastructure-cloud-integration-dev-tools-50/restful-api-testing-with-postman-along-with-aurena-10144

 

Hope this will helps you.

 

/Banuka.

 

Thought it would be worth adding following info as well to @Banuka Perera’s reply above. 

Enabling compatibility application type as above, exposes the projection to be used with basic authentication. By default, only projections of Integration category are exposed through basic authentication. 

For projections that do not have this enabled by default, it should be done selectively when OAuth is not an option and after carefully considering the network security as well. Basic authentication is a legacy technology and does not meet current security or compliance requirements, therefore it is advised to use OAuth as much as possible. As far as I know, In IFS Cloud, basic authentication is planned to be removed for APIs.

You can find this in following documentation as well:

https://docs.ifs.com/techdocs/foundation1/045_administration_aurena/240_integration/020_api_explorer/default.htm

 

Hope this helps!