RESTful HTTP API - Side Loading

Side loading is the ability to add OCFL objects to a Fedora-managed OCFL storage root and have those objects become both visible via and managed by Fedora.

Side-load a resource

Before invoking this method you must copy your conforming OCFL object into your OCFL repository.  Note the path to the new resource must match the value of the "id" field in the inventory.json file in your object root.  For example, assuming that your repository's base URI is http://localhost:8080/rest and  the object root's inventory.json file's "id" field  equals info:fedora/path/to/new/resource you would post to http://localhost:8080/rest/path/to/new/resource/fcr:reindex.   For the details on the structure of OCFL objects expected see Fedora OCFL Object Structure.

Request URI: /path/to/new/resource/fcr:reindex

Methods: POST

POSTMake Fedora aware of  a resource directly copied to your underlying OCFL. 

Example:

curl -X POST http://localhost:8080/rest/path/to/resource/fcr:reindex

Response:

HTTP/1.1 204 No Content

Status:

204  No Content

400 Bad request: The specified object could not be side-loaded because the resource was not found in the OCFL or the OCFL object is invalid.  For the definition of valid objects, see Fedora OCFL Object Structure.

409 Conflict:  The specified resource already exists.