question Re: Want to limit query to 50 records at a time while making a GET query. in Developer forum

Want to limit query to 50 records at a time while making a GET query.

Chandresh — Thu, 07 Jan 2016 13:13:10 GMT

Hello All,I want to limit

I want to limit query to 50 records at a time while making a GET call to Service Now. I have checked there is one parameter(sysparm_limit) by which I can limit the number of queries at a time but I want that if number of records are 10000 then it should get all the records but in 50 records per query fashion. Any idea how to achieve this.

Re: Want to limit query to 50 records at a time while making a GET query.

Deepak Ingale1 — Thu, 07 Jan 2016 13:17:23 GMT

Hi Chandresh,

http://wiki.servicenow.com/index.php?title=Table_API#Methods

Re: Want to limit query to 50 records at a time while making a GET query.

Chandresh — Thu, 07 Jan 2016 13:37:55 GMT

Hi Deepak,

Could you please explain below examples given in the above link, what is the signoificance of rel="next", "prev" etc.

*****************************************************************************************

Link: REST message data can be split into multiple result sets rather than forcing the user to submit multiple requests. The header has different links available for the first set, previous set, next set, and the last set of records, where applicable.

For example:
{instance}/api/now/table/cmdb_ci?sysparm_offset=40&sysparm_limit=10000>;rel="next",
{instance}/api/now/table/cmdb_ci?sysparm_offset=40&sysparm_limit=10000>;rel="prev",
{instance}/api/now/table/cmdb_ci?sysparm_offset=0&sysparm_limit=10000>;rel="first",
{instance}/api/now/table/cmdb_ci?sysparm_offset=2780&sysparm_limit=10000>;rel="last"

Note: The sysparm_limit parameter defaults to 10,000 records. This limit can be set to any value, however, an unusually large value can impact system performance.

X-Total-Count: The total count of records returned by query.

*****************************************************************************************

Re: Want to limit query to 50 records at a time while making a GET query.

Deepak Ingale1 — Thu, 07 Jan 2016 13:54:30 GMT

Hi Chandresh,

I have not tried it yet, but reading from the description what I could make out is like

1) rel="next" must be providing you the next set of data , so you might have to use only this method with proper offset and sysparm_limit value

2) rel="prev" must be providing you the previous set of data and so on

I would strongly suggest to wait for an update from someone else who have actually worked on it OR if it is urgent for you, I would suggest to use "Chrome REST APIs extension" to query against the demo servicenow instance with permutations and combinations to check what does it mean

I would use the GET method against Incident table with sysparm_limit of 20 and will set offset limit of 5

Re: Want to limit query to 50 records at a time while making a GET query.

Chandresh — Fri, 08 Jan 2016 08:59:31 GMT

Thank you Deepak for your response, Well I have tried a different way and it is working fine. I have used chooseWindow query method. I have created a processor which I can call and passed the parameters in chooseWindow query method.

Below is the syntax:

8.12 chooseWindow(Number f, Number l, Boolean forceCount)

Re: Want to limit query to 50 records at a time while making a GET query.

venkata_koya — Fri, 29 Jan 2016 22:19:44 GMT

Right way is to use REST API with sysparm_limit parameter instead of spinning up your own processor. It will give you option to go back and forth in result set using urls provided in Link header

Re: Want to limit query to 50 records at a time while making a GET query.

Chandresh — Tue, 02 Feb 2016 05:58:26 GMT

Hi Venkata,

Thank you for your valuable feedback. Here is the scenario.

I have a processor which is post, let's say, incidents to incidents table whenever user clicks on My incidents tab in UI interace. We have integrated Service Now with this UI interface.Now initially it should give 30 records and on scrolling down it should give next 30 records and so on. Could you please suggest how to set it up using sys_limit parameter.

Re: Want to limit query to 50 records at a time while making a GET query.

venkata_koya — Mon, 08 Feb 2016 17:49:51 GMT

The idea of having sysparm_limit and link header is exactly to support this scenario. When you make your first call on load of page, you pass sysparm_limit =30 as query parameter.

With the response, you will get next, prev link in headers. when ever you scroll down, you make next call to get next 30 records using next and keep going

It is recommended to use ORDERBY so you don't get duplicate records because of changes in DataBase plan which might re order results causing duplicates

For eg. My initial request for 10 records looks like this

https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on

Response will have Link header

Link â†’

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=0>;rel="first",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=10>;rel="next",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=560>;rel="last"

If you see here there is link for rel=next, which gives you next 10 records. There are libraries out there which can parse this header elegantly to get proper links for next, first,last set of records.

In this case, we need to get 'rel=next' link and make subsequent request to get next 10 records

https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=10

Response will have another set of headers with again next, prev link to get that set of records

Link â†’

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=0>;rel="first",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=0>;rel="prev",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=20>;rel="next",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=560>;rel="last"

Re: Want to limit query to 50 records at a time while making a GET query.

mjjit — Tue, 14 Feb 2017 21:19:05 GMT

I realize this is a post from a year ago.... but have a question about libraries to parse the header elegantly. Are the libraries referenced (below in bold)... ServiceNow platform libraries or from third party?

Response will have Link header

Link â†’

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=0>;rel="first",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=10>;rel="next",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=560>;rel="last"

If you see here there is link for rel=next, which gives you next 10 records. There are libraries out there which can parse this header elegantly to get proper links for next, first,last set of records.

In this case, we need to get 'rel=next' link and make subsequent request to get next 10 records

https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=10

Response will have another set of headers with again next, prev link to get that set of records

Link â†’

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=0>;rel="first",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=0>;rel="prev",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=20>;rel="next",

<https://instance.service-now.com/api/now/table/sys_user?sysparm_limit=10&sysparm_query=ORDERBYsys_created_on&sysparm_offset=560>;rel="last"

Re: Want to limit query to 50 records at a time while making a GET query.

adambraden — Wed, 13 Sep 2017 19:27:57 GMT

Hey, Michael--were you ever able to find a good solution for parsing those link headers? I'm working on a project where I'm having to utilize those and I was wanting to see if anybody had found an easy solution.

Re: Want to limit query to 50 records at a time while making a GET query.

mjjit — Thu, 14 Sep 2017 00:29:18 GMT

Hey Adam-No, did not find any libraries (at least not on the platform I could refernce) to parse the response. I played with using regex to parse the responses, but ended up going in a different direction. Somewhat simplier.

I ended up writing an initial GET request to the return the count of records by retrieving the header X-Total-Count. Once I had the count, I ran another GET request and iterate through a loop till I had all the records.

Hope this helps

Re: Want to limit query to 50 records at a time while making a GET query.

Y_12 — Tue, 07 Jul 2020 10:42:10 GMT

Which is the library to get ;rel="next", from header?

How can i extract ;rel="next", from header response?