The REST API is accessible over HTTP/HTTPS (although HTTP would usually be disabled) and currently provides read-only access to the database. It can serve data in JSON, XML and HTML formats. It is available on your own system by appending "/webdav" to your normal login URL. This means it will look like:

 

https://yourcalpendo/webdav

 

An example can be seen by pointing the web browser at https://demo.calpendo.com/webdav and logging in with the username "admin" and password "admin".

 

After going to the above address, click on items and navigate through your data. Accessing via a normal web browser means you will be looking at the HTML formatted output.

 

Accessing The API Over wget

In order to automate the API, you can use a utility like wget. Here is an example of requesting JSON-formatted output:

 

wget -O - --header="Accept: application/json" --user=USER --password=PASSWORD https://yourcalpendo/webdav

 

The URL /webdav will show all available services that can be discovered by following the links in the output (see HATEOAS).

 

The query API /webdav/q (described in the next section) is not shown by /webdav because the format of its URLs are not discoverable from the UI. Currently, the only service available at the top level is

 

/webdav/b

 

which lists all the known Biskit Types, and provides a URL showing how to list each of them. It is likely that there will be other services available under /webdav in the future (for example, to run reports that have been saved).

 

Example showing all instances of Project:

 

wget -O - --header="Accept: application/json" --user=USER --password=PASSWORD https://yourcalpendo/webdav/b/Project

 

For details of the REST API, you can use its discoverability features to follow links directly from calls to /webdav/.