Reply
This is an open group. Sign in and click the "Join Group" button to become a group member and start posting.
Highlighted
yamasaki1ma Valued Scholar

Valued Scholar

Valued Scholar
Posts: 25
Registered: ‎02-22-2017
There is an incorrect "Note" in the QueryMore description of the REST API reference.
[ Edited ]

I confirmed the reference to use QueryMore.

But I was confused. This is because two different descriptions of the retention period of queryLocator are described:
https://www.zuora.com/developer/api-reference/#operation/Action_POSTqueryMore
1.
> Any queryLocator results greater than 2,000, will only be stored by Zuora for 5 days before it is deleted.
2.
> Note: Zuora expires queryMore cursors after 15 minutes of activity.
* I assume that "queryMore cursors"  is the same as queryLocator.

 

I experimented:

  • First I ran query and retrieved queryLocator.
  • And I ran queryMore using this queryLocator. Response was returned normally.
  • Furthermore, after 1 hour, I used this queryLocator again to run queryMore. Response was returned normally.

Therefore, I think the second descriptions is incorrect.

 

I have read the explanation of SOAP QueryMore while waiting for 1 hour.
https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/E_SOAP_API_Calls/queryMore_call
It is written as "As of WSDL 20.0, Zuora will now expire queryMore() cursors after 15 minutes of activity".
I assume that this description was moved to the REST API reference due to some mistake.

DavidW Documentation Team

Documentation Team

Documentation Team
Posts: 8
Registered: ‎08-23-2016
Re: There is an incorrect "Note" in the QueryMore description of the REST API reference.

Hi @yamasaki1ma

 

Thank you for letting us know about the inconsistency in the API Reference, and for your detailed investigation!

 

I'm checking how queryLocator currently works so that we can get the docs clarified. I'll update you when I have more info.

 

Thanks again!

DavidW Documentation Team

Documentation Team

Documentation Team
Posts: 8
Registered: ‎08-23-2016
Re: There is an incorrect "Note" in the QueryMore description of the REST API reference.

Hi @yamasaki1ma, sorry for the delay in getting back to you. I wanted to let you know that I am investigating the correct way to document this, and have not forgotten about it.

 

Will follow up again soon.

 

Thanks,

David

DavidW Documentation Team

Documentation Team

Documentation Team
Posts: 8
Registered: ‎08-23-2016
Re: There is an incorrect "Note" in the QueryMore description of the REST API reference.

Hi @yamasaki1ma,

 

To answer one of your original questions - yes, "queryMore cursor" means a value of queryLocator.

 

From our initial investigations, it appears that queryLocator values are considered to have expired after 15 minutes of inactivity. However, as you (and I) have observed, it is possible to continue to use a queryLocator value beyond the 15 minute mark. We will have to do further investigation to figure out how long queryLocator values can be used for in practice.

 

For now, my recommendation is that you treat all queryLocator values as having expired after 15 minutes. I hope this is OK. I will follow up with more information as I have it.

 

Thanks again for your understanding.