GET {clientId}/export/CID/{accessToken}?limit={limit}&offset={offset}&keepAlive={keepAlive}
Retrieve the data. You may iterate through multiple calls until all records are retrieved. The access token will expire automatically upon complete data retrieval. Set the keepAlive parameter to true to retrieve data beyond the initial retrieval. The default value is set to false, if not specified.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
PossibleNow ClientId |
string |
Required |
| accessToken |
AccessToken to pull data for |
integer |
Required |
| limit |
Specifies the maximum number of records to return |
integer |
None. |
| offset |
Specifies 1 based starting point for the batch of records to retrieve |
integer |
None. |
| keepAlive |
Optional, defaults to false. If specified and true, then DO NOT mark the data as retrieved when the last block of data has been retrieved. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
CIDPreferenceResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Messages | Collection of CIDPreferenceResultMessage |
None. |
|
| Count |
The number of records in the current batch |
integer |
None. |
| HasMore |
Indicates if there are additional records available for retrieval |
boolean |
None. |
| Limit |
Specifies the maximum number of records to return. Defaults to 1000, if not specified |
integer |
None. |
| Offset |
Used in conjunction with limit that specifies the starting point to retrieve the next batch of records. Defaults to 1, if not specified. For example, if your limit is 100 and you specify an offset of 100, the system returns records from 100 through 200. |
integer |
None. |
| TotalResults |
The total number of records generated by the system for the export request. |
integer |
None. |
| Preferences |
Collection of Preferences. |
Collection of PreferenceWithOperation |
None. |
Response Formats
application/json, text/json
Sample not available.