Root Resource


The root resource identifies the available resources available to an application (across all users) and the URIs for accessing them.


Because the root resource contains application-level information, rather than user-specific information, the standard user-specific access token is not used for authentication. Rather, HTTP Basic authentication is used.

To authenticate using Basic authentication:

  1. Concatenate the client ID, a colon (":"), and the client secret.
  2. Encode the string using Base64 encoding.
  3. Pass the Base64-encoded string to the server in the Authorization header in the following form:

    Authorization: Basic <encoded-string>

For example, if the client ID is 1234abcd and the client secret is 7890wxyz, then the following header should be included when making a call for the root resource:

Authorization: Basic MTIzNGFiY2Q6Nzg5MHd4eXo=


Field Type Description Editable
change_logs ChangeLog[] The current change logs for the application N

Array Structures

Each of the following array types consists of the respective fields listed.


Field Type Description
userID Integer The unique ID of the user for the change log
uri String The URI of the change log

Supported Operations

Retrieving Root Information

To retrieve the root resource for the application, GET the API root document (i.e.,

The modifiedNoEarlierThan and modifiedNoLaterThan may be used to restrict the information returned. Each takes the following format:


N.B.: To manage system load, the time window for changes can be no longer than seven days. Requests for changes over a longer interval will be adjusted such that the modifiedNoEarlierThan time is seven days prior to the modifiedNoLaterThan time.