Interface CollectionApiCreateCollectionRequest

Request parameters for createCollection operation in CollectionApi.

Export

CollectionApiCreateCollectionRequest

interface CollectionApiCreateCollectionRequest {
    ids?: string[];
    isLocked?: boolean;
    name?: string;
    parentId?: string;
}

Properties

ids? isLocked? name? parentId?

Properties

Optional Readonlyids

ids?: string[]

Item Ids to add to the collection.

Memberof

CollectionApiCreateCollection

Optional ReadonlyisLocked

isLocked?: boolean

Whether or not to lock the new collection.

Memberof

CollectionApiCreateCollection

Optional Readonlyname

name?: string

The name of the collection.

Memberof

CollectionApiCreateCollection

Optional ReadonlyparentId

parentId?: string

Optional. Create the collection within a specific folder.

Memberof

CollectionApiCreateCollection

Settings

Member Visibility

On This Page

Properties