polydb:rest:intro

This is an old revision of the document!


The polyDB can be accessed via a REST API

Base path:

https://polydb.org/beta/rest/current/

Section

Section Documentation and a lsit of subsections and collections in this section:

/section/<sectionname>/<subsectionname>/... 

with possible parameters

recursive={0,1}

and

short={0,1}

. Example:

/section/Polytopes?recursive=1

returns

{

    "description": "A collection of families of polytopes",
    "subsections": [
        "Polytopes.Combinatorial",
        "Polytopes.Geometric",
        "Polytopes.Lattice"
    ],
    "collections": [
        "Polytopes.Combinatorial.01Polytopes",
        "Polytopes.Combinatorial.CombinatorialTypes",
        "Polytopes.Combinatorial.FacesBirkhoffPolytope",
        "Polytopes.Combinatorial.SmallSpheresDim4",
        "Polytopes.Geometric.01Polytopes",
        "Polytopes.Lattice.01Polytopes",
        "Polytopes.Lattice.ExceptionalMaximalHollow",
        "Polytopes.Lattice.Reflexive",
        "Polytopes.Lattice.SmoothReflexive"
    ]

}

sections

collection

/collection/Tropical/SchlaefliFan

collections

/collections/Tropical/

find

Example

/find/Polytopes/Lattice/Reflexive?query={"N_VERTICES"%3A5}&limit=10&skip=100

find_one

Example

/find_one/Polytopes/Lattice/Reflexive?query={"N_VERTICES"%3A5}

distinct

count

schema

Example

/schema/Polytopes/Lattice/Reflexive
  • polydb/rest/intro.1585645096.txt.gz
  • Last modified: 2020/03/31 08:58
  • by paffenholz