| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name |
Optional<String> | ➖ | The optional name of the Collection item. | |
description |
Optional<String> | ➖ | A helpful description of why this CollectionItem is in the Collection that it's in. | |
icon |
Optional<String> | ➖ | The emoji icon for this CollectionItem. Only used for Text type items. | |
collectionId |
long | ✔️ | The Collection ID of the Collection that this CollectionItem belongs in. | |
documentId |
Optional<String> | ➖ | If this CollectionItem is indexed, the Glean Document ID of that document. | |
url |
Optional<String> | ➖ | The URL of this CollectionItem. | |
itemId |
Optional<String> | ➖ | Unique identifier for the item within the Collection it belongs to. | |
createdBy |
Optional<Person> | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
createdAt |
OffsetDateTime | ➖ | Unix timestamp for when the item was first added (in seconds since epoch UTC). | |
document |
Optional<Document> | ➖ | N/A | |
shortcut |
Optional<Shortcut> | ➖ | N/A | |
collection |
Optional<Collection> | ➖ | N/A | |
itemType |
CollectionItemItemType | ✔️ | N/A |