polydb:rest:intro

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
Last revisionBoth sides next revision
polydb:rest:intro [2020/04/01 19:12] – paffenholzpolydb:rest:intro [2023/03/24 21:52] – [polyDB REST API] paffenholz
Line 5: Line 5:
 Base path: Base path:
 <code> <code>
-https://polydb.org/beta/rest/current/+https://polydb.org/rest/current/
 </code> </code>
  
Line 23: Line 23:
     * id     * id
  
-For more information see below. +Some examples are below. For a full documentation of all endpoints with examples for data and code see [[https://polymake.org/polytopes/paffenholz/polyDB-rest.html|here]].
  
 ==== Obtain info on available collections ==== ==== Obtain info on available collections ====
Line 31: Line 31:
 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:
 <code> <code>
-https://polydb.org/beta/rest/current/section/<sectionname>/<subsectionname>/... +https://polydb.org/rest/current/section/<sectionname>/<subsectionname>/... 
 </code> </code>
 with possible parameters <code>recursive={0,1}</code> and <code>short={0,1}</code>. Example: with possible parameters <code>recursive={0,1}</code> and <code>short={0,1}</code>. Example:
 <code> <code>
-https://polydb.org/beta/rest/current/section/Polytopes?recursive=1+https://polydb.org/rest/current/section/Polytopes?recursive=1
 </code> </code>
 returns returns
Line 75: Line 75:
 Here is an example: Here is an example:
 <code> <code>
-https://polydb.org/beta/rest/current/collection/Tropical/SchlaefliFan+https://polydb.org/rest/current/collection/Tropical/SchlaefliFan
 </code> </code>
  
Line 87: Line 87:
 Example: Example:
 <code> <code>
-https://polydb.org/beta/rest/current/collections/Tropical/+https://polydb.org/rest/current/collections/Tropical/
 </code> </code>
 returns returns
Line 109: Line 109:
 Example: Example:
 <code> <code>
-https://polydb.org/beta/rest/current/find/Polytopes/Lattice/Reflexive?query={"N_VERTICES"%3A5}&limit=10&skip=100+https://polydb.org/rest/current/find/Polytopes/Lattice/Reflexive?query={"N_VERTICES"%3A5}&limit=10&skip=100
 </code> </code>
 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.
Line 119: Line 119:
 Example: Example:
 <code> <code>
-https://polydb.org/beta/rest/current/find_one/Polytopes/Lattice/Reflexive?query={"N_VERTICES"%3A5}+https://polydb.org/rest/current/find_one/Polytopes/Lattice/Reflexive?query={"N_VERTICES"%3A5}
 </code> </code>
    
Line 129: Line 129:
 This counts the number of results that match a given query. Example: This counts the number of results that match a given query. Example:
 <code> <code>
-https://polydb.org/beta/rest/current/count/Polytopes/Combinatorial/01Polytopes?query={"N_VERTICES"%3A15}+https://polydb.org/rest/current/count/Polytopes/Combinatorial/01Polytopes?query={"N_VERTICES"%3A15}
 </code> </code>
 returns returns
Line 142: Line 142:
 Example Example
 <code> <code>
-https://polydb.org/beta/rest/current/id/Polytopes/Combinatorial/01Polytopes/5d.15v.10f.C8+https://polydb.org/rest/current/id/Polytopes/Combinatorial/01Polytopes/5d.15v.10f.C8
 </code> </code>
  
Line 152: Line 152:
 Example Example
 <code> <code>
-https://polydb.org/beta/rest/current/schema/Polytopes/Lattice/Reflexive+https://polydb.org/rest/current/schema/Polytopes/Lattice/Reflexive
 </code> </code>
  
  • polydb/rest/intro.txt
  • Last modified: 2023/03/24 21:55
  • by paffenholz