OpenEBench REST API


OpenEBench REST API has two endpoints: one for the production './staged' and another one for the sandbox './sandbox'.
/sandbox/?community_id={community_id}Content-Type: application/json Submit OpenEBench data as an array of json objects. Objects' types and ids are taken from the '_id' and '_schema' attributes.
/sandboxAccept: application/jsonGet all authenticated user submitted data.
/sandbox/{collection}/?privileged={true | false} Accept: application/json List OpenEBench collection of submitted data. If privileged=true only 'privileged' objects (those the user is authorized to write) are returned.
/sandbox/{collection}Accept: text/uri-listList all OpenEBench collection data identifiers.
/sandbox/{collection}Accept: text/x-uriGet the URI of the JSON Schema to validate the collection.
/sandbox/{collection}Accept: application/schema+jsonGet the JSON Schema to validate the collection.
/sandbox/{collection}/?community_id={community_id}Content-Type: application/json Submit OpenEBench collection of data as an array of json objects. Objects' identifiers are taken from the object's '_id' attribute.
/sandbox/{collection}/{id}Check whether the object exists in the submission.
/sandbox/{collection}/{id}Get OpenEBench submitted data object.
/sandbox/{collection}/{id}/?community_id={community_id}Content-Type: application/jsonSubmit OpenEBench data object.
/sandbox/{collection}/{id}Content-Type: application/jsonUpdate OpenEBench data object.
/sandbox/{collection}/{id}Remove OpenEBench object from submission.
/staged/?community_id={community_id}Content-Type: application/json Upload OpenEBench data as an array of json objects. Objects' types and ids are taken from the '_id' and '_schema' attributes.
/staged/{collection}/?privileged={true | false} Accept: application/json List entire OpenEBench collection. If privileged=true only 'privileged' objects (those the user is authorized to write) are returned.
/staged/{collection}Accept: text/uri-listList all OpenEBench collection data identifiers.
/staged/{collection}Accept: text/x-uriGet the URI of the JSON Schema to validate the collection.
/staged/{collection}Accept: application/schema+jsonGet the JSON Schema to validate the collection.
/staged/{collection}/?community_id={community_id}Content-Type: application/json Upload OpenEBench collection of data as an array of json objects. Objects' identifiers are taken from the object's '_id' attribute.
/staged/{collection}/{id}Check whether the object exists in the collection.
/staged/{collection}/{id}Get OpenEBench data object.
/staged/{collection}/{id}/?community_id={community_id}Content-Type: application/jsonInsert OpenEBench data object.
/staged/{collection}/{id}Content-Type: application/jsonUpdate OpenEBench data object.
/staged/{collection}/{id}Mark OpenEBench data object as deleted.