HomeAboutCreate a collection.

Create a collection.

22Aug2011 Posted by admin

Create a new collection, with some metadata. The title and description must be set with an extra /collection/{coll_id} [POST] call.

Request URL

/collection/create [POST]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
user_id (ALPHA_NUM)The user ID, will become the owner of the collection.Required-
category (BOOL)Used to identify main category collections, use [GET] /collection?category=true to get these collections.Optionalfalse-
description (STRING)Description of the new collection.Optional-
group_id (ALPHA_NUM)The group ID, will be used for the group_id of the collection.Optional-
isprivate (BOOL)If isprivate = true, then the collction is not displayed in public lists, such as top 10, last uploaded, etc.Optionalfalse-
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-
private (BOOL)Used to identify private collections, use [GET] /collection?private=true to get these collections.Optionalfalse-
public (BOOL)Used to identify public collections, use [GET] /collection?public=true to get these collections.Optionaltrue-
public_assign (BOOL)A 'true' value indicates that all users have access to the collection entitled to assets.Optionalfalse-
title (STRING)The title of the new collection.Optional-

Example Request

/collection/create [POST]

Example Response

<items>
  <item id="1">
    <coll_id>3</coll_id>
  </item>
</items>