Skip to content
This repository has been archived by the owner on Jul 2, 2018. It is now read-only.

Collections: Release or discard a collection

Jump to bottom
Natasa Bulatovic edited this page Jun 3, 2016 · 4 revisions

##PUT /collections/:id/release

  • Releases a collection with this collection id

####Response status codes #####200 OK Successful release of the collection with provided :id

#####404 Not found The collection with provided :id is not found (does not exist)

#####401 Unauthorized Authentication is necessary to release this collection

#####403 Forbidden Wrong credentials provided to release this collection

#####422 Unprocessable Entity Collection can not be released due to validation errors such as: collection has been already released or withdrawn;

#####405 Method not supported (private mode only) If the imeji Instance runs in a private mode, no release or discard of objects is allowed.

####Example request

  ` curl --user admin:admin \`
       `--request PUT \`
       `https://<baseurl>/collections/FKMxUpYdV9N2J4XG/release`

####Example response By successful release, this method should return 200 OK as response code + JSON representation of the released collection (for successful releases only).

See Collections: Get a single collection example

##PUT /collections/:id/discard

  • Discards a collection with this collection id

###Parameters (discard only)

  • discardComment - text representing the discard comment

####Response status codes #####200 OK Successful discard of the collection with provided :id

#####404 Not found The collection with provided :id is not found (does not exist)

#####401 Unauthorized Authentication is necessary to discard this collection

#####403 Forbidden Wrong credentials provided to discard this collection

#####422 Unprocessable Entity Collection can not be discarded due to validation errors such as: collection has been already discarded or is not in released status;

#####405 Method not supported (private mode only) If the imeji Instance runs in a private mode, no release or discard of objects is allowed.

####Example request

 ` curl --user admin:admin \
       --header "Content-Type:application/json" \
       --header "Accept: application/json" 
       --data '{"discardComment":"Test with CURL Discarding "}'  PUT \
          https://<baseurl>/collections/FKMxUpYdV9N2J4XG/discard`

####Example response By successful discard, this method should return 200 OK as response code + JSON representation of the discarded collection (for successful discards only).

See Collections: Get a single collection example

Clone this wiki locally