Skip to content
Snippets Groups Projects
Commit addaf49c authored by Alexander Schlemmer's avatar Alexander Schlemmer
Browse files

documentation of the paging

parent 313a92fa
Branches
Tags
No related merge requests found
The Paging flag splits the retrieval of a (possibly huge) number entities into pages.
# Syntax
flag = name, [":", value];
name = "P";
value = [ index ], ["L", length]];
index = ? any positive integer ?;
length = ? any positive integer ?;
# Semantics
The `index` (starting with zero) denotes the index of the first entity to be retrieved. The `length` is the number of entities on that page. If `length` is omitted, the default number of entities is returned (as configured by a server constant called ...). If only the `name` is given the paging behaves as if the `index` has been zero.
# Examples
`https://caosdb/Entities/all?flags=P:24L50` returns 50 entities starting with the 25th entity which would be retrieved without paging.
`https://caosdb/Entities/all?flags=P:24` returns the default number of entities starting with the 25th entity which would be retrieved without paging.
`https://caosdb/Entities/all?flags=P:L50` returns 50 entities starting with the first entity which would be retrieved without paging.
`https://caosdb/Entities/all?flags=P` returns the default number of entities starting with the first entity which would be retrieved without paging.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment