ICiconik

Create a new collection

Required roles:

  • can_create_collections
post/v1/collections/

Request

Query parameters

apply_default_aclsboolean

Adds default ACLs to a collection

apply_collection_aclsboolean

Adds containing collection's ACLs to a collection

restrict_collection_aclsboolean

Restricts ACLS to containing collection's ACLs

apply_acl_template_idstring uuid

Adds template ACLs to a collection

low_priority_indexingboolean

If true, the parent collection content is reindexed using the low priority queue

Headers

App-IDstring required
Auth-Tokenstring required

Request body

categorystring nullable
custom_keyframestring uuid nullable
custom_posterstring uuid nullable
date_createdstring date-time
external_idstring nullable
is_rootboolean
keyframe_asset_idsstring[]
parent_idstring uuid nullable
status'ACTIVE' | 'HIDDEN' | 'DELETED'
storage_idstring uuid nullable
titlestring required

Response

Returns a created collection

categorystring nullable
created_by_userstring uuid
custom_keyframestring uuid nullable
custom_order_status'DISABLED' | 'ENABLING' | 'ENABLED'
custom_posterstring uuid nullable
date_createdstring date-time
date_deletedstring date-time
date_modifiedstring date-time
date_viewedstring date-time
deleted_by_userstring uuid
external_idstring nullable
favouredboolean
idstring uuid
in_collectionsstring[]
is_rootboolean
keyframe_asset_idsstring[]
keyframesobject[]
metadataobject
object_typestring
parent_idstring uuid nullable
parentsstring[]
permissionsstring[]
positioninteger
project_idstring uuid
status'ACTIVE' | 'HIDDEN' | 'DELETED'
storage_idstring uuid nullable
titlestring required

Changes

No recorded changes to this operation across all 1 revision of this API.