HomeAboutDelete a collection.

Delete a collection.

22Aug2011 Posted by admin

Delete the given collection. Only the owner is allowed to delete the collection.

Collections can only be removed when there are no assets linked to it, or if the parameter delete=cascade is given.

When you use the 'delete = cascade' parameter, then all of the linked assets, mediafiles, stills and metadata will be deleted too, even if the assets are also used in other collections. Each asset is verified that the user_id is also the owner of the asset, otherwise the call fails.

Request URL

/collection/$coll_id/delete [POST]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
coll_id (ALPHA_NUM)The collection ID.Required-
user_id (ALPHA_NUM)The user ID.Required-
delete (STRING)Delete mode. Use this parameter with value 'cascade' to delete *all* of the underlying items: assets with metadata, mediafiles, stills. The collection is deleted only if all underlying assets successfully removed.
Value (when supplied) must be either "" or "cascade".		Optional-
mediamosa_version (MEDIAMOSA_VERSION)Provide the version to get the REST call returned in the format of the specified MediaMosa version. Keep empty or skip to retrieve in current (latest) version. Provide '2' to retrieve the REST call in 2.x format. Or be more specific by providing up to 3 digits; '2.3.0'. This setting will override any setting used by client application or the default setting in MediaMosa.Optional-

Example Request

/collection/o1n8DMqafOMP7MgcWsnTUmvf/delete [POST] user_id=foo

Example Response

<request_result>success</request_result>
<request_result_id>601</request_result_id>