| Field | Type | Required | Description |
|---|---|---|---|
name |
String | ✔️ | The unique name of the Collection. |
description |
Optional<String> | ➖ | A brief summary of the Collection's contents. |
addedRoles |
List<UserRoleSpecification> | ➖ | A list of added user roles for the Collection. |
removedRoles |
List<UserRoleSpecification> | ➖ | A list of removed user roles for the Collection. |
audienceFilters |
List<FacetFilter> | ➖ | Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. |
icon |
Optional<String> | ➖ | The emoji icon of this Collection. |
adminLocked |
Optional<Boolean> | ➖ | Indicates whether edits are allowed for everyone or only admins. |
parentId |
Optional<Long> | ➖ | The parent of this Collection, or 0 if it's a top-level Collection. |
thumbnail |
Optional<Thumbnail> | ➖ | N/A |
allowedDatasource |
Optional<String> | ➖ | The datasource type this Collection can hold. |
newNextItemId |
Optional<String> | ➖ | The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection. Only used if parentId is specified. |