Collections are the top level organizational unit (see How information is organized). A collection can include datasets and other collections. Each collection has associated metadata, described by the attributes below.

Collection attributes

ancestors array An ordered array of collections describing the hierarchy of collections containing the collection. The first item in this array is the topmost collection in the hierarchy, and the last item is the immediate parent of the collection. READ
created_at string <date-time> Date-time stamp indicating when the collection was created. READ
deletable boolean true if the user making the GET request has permission to delete the resource; false otherwise. READ
description string Description of the dataset (displayed in the Assembly client interface).
description_short string Short description of the collection.
display_name string Human-readable name for the collection (used to refer to it in lists and elsewhere in the user interface). REQUIRED
editable boolean true if administrators can edit the collection metadata through the user interface; false otherwise. READ
highlights array For collections returned based on a search string, this provides positional information indicating where instances of the specified query string occur. READ
id string <uuid> The collection’s unique identifier. This never changes.
key_value object A dictionary object containing key-value pairs (used for custom metadata)2.
modified_at string <date-time> Date-time stamp indicating the last time the collection was modified. READ
owner_id string <uuid> The unique identifier of the user who created the resource. READ
parent_collection object Reference to the collection that directly contains this collection.
published boolean true if this collection should be visible to non-admin users; false otherwise. Default is false.
score number A relevance score assigned when using the query parameter to search for matching collections. READ
tags array The tags assigned to this collection3.

2 key_value supports custom metadata. Any custom metadata is displayed under the “Custom fields” heading in the collection inspector pane in the Enigma Public user interface.

3 The tags attribute is not yet supported.

Sample collection model