List a recording's objects

Download an object

GET /services/objects/{object id}

Upload a new object to a recording

See the Datasets resource.

Delete an object

Deletes an object along with its metadata and user defined metadata.

DELETE /services/objects/{object id}

You can include an If-Match header in your request with the value of eTag from the object listing response to make sure you are aware of any changes before deleting the object.

Object metadata

Objects have metadata. To get an object's metadata use:

Get an object's metadata (dev)

GET /services/objects/{object id}?metadata

Note: This is not implemented yet. But the same information can be retrieved by listing all objects in a recording.

Update an object's metadata (dev)

One field of the metadata, description is optional and is controlled by the user. Use

PATCH /services/objects/{object id}?metadata

to add, modify, or delete the description. No other metadata field can be modified by users.

TODO: Describe patch request body format.

You can include an If-Match header in your request with the value of eTag from the object listing response to make sure you are aware of any changes before modifying the description.

User defined metadata

An object can also have user defined metadata in the form of JSON.

Get user defined metadata (dev)

GET /services/objects/{object id}?user-defined-metadata

If the object does not have any user defined metadata then a 404 response is returned.

Add or replace user defined metadata (dev)

PUT /services/objects/{object id}?user-defined-metadata

The body of the request must be a well formed JSON string.

You can include an If-Match header in your request with the value of eTag from the object listing response to make sure you are aware of any changes before modifying the user defined metadata.

Delete an object's user defined metadata (dev)

DELETE /services/objects/{object id}?user-defined-metadata

You can include an If-Match header in your request with the value of eTag from the object listing response to make sure you are aware of any changes before deleting the user defined metadata.