Keywords: Signals Notebook, API, skip records
Details:
When using the API, you may want to skip XYZ number or records when pulling items.
The first thing we need to know is if the endpoint we are trying to use allows skipping records.
If you have administrator privileges, you can navigate to the API page (swagger), check the list of available endpoints and a description of what they do. (This scenario assumes you have the API key and can authenticate)
https://your-tenant-url/docs/extapi/swagger/index.html
If the endpoint you are looking to use supports skipping records, you'll find page[offset] in the list of available parameters, it means you can skip records when using this endpoint.
An example would be the following:
I want to pull a list of every notebook I have. I remember the first 3 notebooks I created were tests so I don't want to include them in the results.
I can use an GET request using this URL
https://your-tenant-url/api/rest/v1.0/entities?page%5Boffset%5D=3&includeTypes=journal
Comments
0 comments
Article is closed for comments.