REST API Parameters

Once you know what area and Graph name you're addressing, you then use query parameters to specify more details. The available parameters are...

&id= 48 digit hexidecimal value representing the metaversal id of the Vertex or Edge in the graph

&type= String representing the short name of a VertexFrame or EdgeFrame in a Framed graph model

&key= Key for use by a custom KeyResolver to find the vertex requested. Must be used in conjunction with the &type= parameter _ex: http://logos.local/api/oda/frame/now?type=User&key=CN=Nathan%20T%20Freeman/O=REDPILL

&props= comma-separated list of properties to be included for the vertex(s) or edge(s) retrieved

&edges triggers inclusion of edge counts when vertices are returned

&label= returns edge list for a label for any returned vertices

&vertices forces the resolution of adjacent vertices rather than edges. Should be used in conjunction with &label=

&inprops= comma-separated list of properties to be included on inbound edges or vertices. Used in conjunction with &label=

&outprops= comma-separated list of properties to be included on outbound edges or vertices. Used in conjunction with &label=

&filterkey= designates name of a property to be used in a key/value exact match to filter a set of responses. Can be used in frames and frame area (the latter when getting an edge set). Used in conjunction with &filtervalue=

&filtervalue= designates name of a property to be used in a key/value exact match to filter a set of responses. Can be used in frames and frame area (the latter when getting an edge set). Used in conjunction with &filterkey=

&partialkey= designates name of a property to be used in a key/value contains match to filter a set of responses. Can be used in frames and frame area (the latter when getting an edge set). Used in conjunction with &partialvalue=

&partialvalue= designates name of a property to be used in a key/value contains match to filter a set of responses. Can be used in frames and frame area (the latter when getting an edge set). Used in conjunction with &partialkey=

&start= sets starting point for a subset of return elements.

&count= sets size of subset of return elements.

&orderby= comma-separated list of properties to use for sorting a return set.