Query Scope
Scalar API queries are grouped into four scopes. Each scope allows access to a different piece of a Scalar book. A combination of calls might be needed to gain all information about a Scalar book (e.g., the book’s title and all of its content). However, a single call, for example to instancesof/content, will return all content in a Scalar book. Adding a GET variable to the same call will return all content plus all relationships between content, effectively modeling the entire Scalar book in a single query.
Install
Information about a Scalar installation including its title and list of public Scalar books.
URL structure: http://domain/install/rdf
Example: http://scalar.usc.edu/works/rdf
Book
Information about a Scalar book including its title, authors, and table of contents.
URL structure: http://domain/install/book/rdf
Example: http://scalar.usc.edu/works/guide/rdf
InstanceOf
A list of nodes by a certain type (class), such as all nodes (content), text-based nodes (pages), or paths. Supported classes are content, page, media, path, tag, annotation, reply, and reference.
URL structure: http://domain/install/book/rdf/instancesof/class
Examples:
http://scalar.usc.edu/works/guide/rdf/instancesof/content
http://scalar.usc.edu/works/guide/rdf/instancesof/page
http://scalar.usc.edu/works/guide/rdf/instancesof/path
Node
Information about a specific node.
URL structure: http://domain/install/book/rdf/node/node-URI-segment
Previous page on path | Working with the API, page 3 of 6 | Next page on path |
Discussion of "Query Scope"
Add your voice to this discussion.
Checking your signed in status ...