Collection.md

Collection

Fields

Field	Type	Required	Description	Example
name	String	✔️	The unique name of the Collection.
description	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.
permissions	Optional<ObjectPermissions>	➖	N/A
trackingToken	Optional<String>	➖	An opaque token that represents this particular UGC. To be used for /feedback reporting.
id	long	✔️	The unique ID of the Collection.
createTime	OffsetDateTime	➖	N/A
updateTime	OffsetDateTime	➖	N/A
creator	Optional<Person>	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
updatedBy	Optional<Person>	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
itemCount	Optional<Long>	➖	The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
childCount	Optional<Long>	➖	The number of children Collections. Separated from the actual children so we can grab the count without children.
items	List<CollectionItem>	➖	The items in this Collection.
pinMetadata	Optional<CollectionPinnedMetadata>	➖	N/A
shortcuts	List<String>	➖	The names of the shortcuts (Go Links) that point to this Collection.
children	List<Collection>	➖	The children Collections of this Collection.
roles	List<UserRoleSpecification>	➖	A list of user roles for the Collection.
favoriteInfo	Optional<FavoriteInfo>	➖	N/A