Application Layer REST API

Owned by Aron Roberts (Unlicensed)
Nov 18, 2013

The CollectionSpace Application layer offers a REST API, complementing that of CollectionSpace's service layer. While this API is primarily called by CollectionSpace's User Interface (UI) layer, the Application layer calls are also accessible directly to your programs and scripts.

For an idea of the types of calls you can make using that API, please see /wiki/spaces/collectionspace/pages/666275577.

Requirements for access

In order to use the Application layer's REST API, your REST client application or browser plug-in, or your programming or scripting language, must be able to do the following:

  • Make HTTP / HTTPS requests, using the GET method to read and list data, and (optionally) the POST, PUT and DELETE methods, respectively, to create, update, and delete data.
  • Create and parse JSON documents.

To use this API with any particular CollectionSpace system, you will also need appropriate credentials and access permissions in that system. Currently, this means that you will need the username and password for an active user account on a CollectionSpace system, which has been granted the required access permissions.