Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
polydb:rest:intro [2020/04/01 12:02] – paffenholz | polydb:rest:intro [2023/03/24 21:55] (current) – paffenholz | ||
---|---|---|---|
Line 5: | Line 5: | ||
Base path: | Base path: | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||
Line 21: | Line 21: | ||
* count | * count | ||
* distinct | * distinct | ||
+ | * id | ||
- | For more information see below. | + | Some examples are below. |
- | ==== Obtain info on available collections ==== | + | The full documentation of all endpoints with examples for data and code **[[https:// |
- | === section | + | ==== Some examples for the REST API ==== |
+ | |||
+ | === Obtain info on available collections === | ||
+ | |||
+ | == section | ||
This returns section documentation and a list of subsections and collections in this section: | This returns section documentation and a list of subsections and collections in this section: | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||
with possible parameters < | with possible parameters < | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||
returns | returns | ||
Line 61: | Line 66: | ||
</ | </ | ||
- | === sections | + | == sections == |
This returns a list of subsections of the given one | This returns a list of subsections of the given one | ||
- | === collection | + | == collection == |
This prints full information on a collection. The collection is given as | This prints full information on a collection. The collection is given as | ||
Line 74: | Line 79: | ||
Here is an example: | Here is an example: | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||
- | === collections | + | == collections == |
This lists all collections contained in a section. | This lists all collections contained in a section. | ||
Line 86: | Line 91: | ||
Example: | Example: | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||
returns | returns | ||
Line 100: | Line 105: | ||
</ | </ | ||
- | ==== Query Data ==== | + | === Query Data === |
- | === find === | + | == find == |
This endpoint does a general query on the given collection and returns a list of the results. You can set the options sort, limit, and skip. However, the query never returns more than 10 entries. | This endpoint does a general query on the given collection and returns a list of the results. You can set the options sort, limit, and skip. However, the query never returns more than 10 entries. | ||
Line 108: | Line 113: | ||
Example: | Example: | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||
will return at most 10 reflexive polytopes with 5 vertices, skipping the first 100 matches. | will return at most 10 reflexive polytopes with 5 vertices, skipping the first 100 matches. | ||
- | === find_one | + | == find_one == |
This works as find, but returns at most one match. The option limit does not apply here. | This works as find, but returns at most one match. The option limit does not apply here. | ||
Line 118: | Line 123: | ||
Example: | Example: | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||
- | === distinct | + | == distinct == |
- | === count === | + | == count == |
This counts the number of results that match a given query. Example: | This counts the number of results that match a given query. Example: | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||
returns | returns | ||
< | < | ||
139983 | 139983 | ||
+ | </ | ||
+ | |||
+ | == id == | ||
+ | |||
+ | Returns a single document by its id. | ||
+ | |||
+ | Example | ||
+ | < | ||
+ | https:// | ||
</ | </ | ||
- | ==== Obtain the JSON Schema for the data ==== | + | === Obtain the JSON Schema for the data === |
- | === schema | + | == schema == |
Example | Example | ||
< | < | ||
- | https:// | + | https:// |
</ | </ | ||