Type Alias CollectionResultResponseBody

A collection.

type CollectionResultResponseBody = {
    createdAt: string;
    creatorId?: string;
    description?: string;
    full?: boolean;
    id: string;
    itemCount: number;
    links: CollectionLinksResponseBody;
    meta?: CollectionMetaResponseBody;
    name: string;
    tenantId: string;
    type: "private" | "public" | "favorite" | "publicgoverned";
    updatedAt: string;
    updaterId?: string;
}
Index

Properties

createdAt creatorId? description? full? id itemCount links meta? name tenantId type updatedAt updaterId?

Properties

createdAt: string

The RFC3339 datetime when the collection was created.

creatorId?: string

The ID of the user who created the collection. This property is only populated if the JWT contains a userId.

description?: string
full?: boolean

States if a collection has reached its items limit or not

id: string

The collection's unique identifier.

itemCount: number

The number of items that have been added to the collection that the user has access to.

links: CollectionLinksResponseBody
meta?: CollectionMetaResponseBody

Collection metadata and computed fields.

name: string
tenantId: string

The ID of the tenant that owns the collection. This property is populated by using JWT.

type: "private" | "public" | "favorite" | "publicgoverned"
updatedAt: string

The RFC3339 datetime when the collection was last updated.

updaterId?: string

The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.

Settings

Member Visibility

On This Page

Properties