API Overview

This section gives a broad overview of how to interact with the Grey Matter Data API.

Structure

For a necessary introduction to the API model, see the Structure section.

Authentication

Grey Matter Data uses JSON Web Tokens (JWT) for authentication.

To learn more, see Authentication with JWT.

Data Retrieval

Initial file listings may be accessed from the root folder with a GET request to the /list/1 endpoint.

The root directory has the well-known Object ID (oid) of 1 by default. This directory may be accessed by all users, although its contents may only be accessed by authenticated users.

Information about Objects in the system may be retrieved through the following means:

• Props - Get the latest Event for a given Object

• List - Get all child Events for a given Object

• Notifications Get all Events for a given Object

• Derived - Get all Objects related to a given Object

• History - Get all Events associated with an Object

Actual file data may be extracted from the system through the following means:

• Stream - As a raw byte stream through the /stream endpoint, used to download the Object locally.

• Show - As a raw byte stream within an iFrame that displays security meta data of the Object, through the /show endpoint, used to view the Object within the browser window.

• Read - Through the /read endpoint which allows for bulk querying.

Data Modification

The only way to modify data in Grey Matter Data is through the /write endpoint.

Utilities

Additional utility endpoints are available. See the Utility Endpoints section.