Type Alias ItemResultResponseBody

An item.

type ItemResultResponseBody = {
    actions: string[];
    collectionIds: string[];
    createdAt: string;
    creatorId?: string;
    description?: string;
    id: string;
    isFavorited: boolean;
    itemViews?: ItemViewsResponseBody;
    links: ItemLinksResponseBody;
    meta: ItemMetaResponseBody;
    name: string;
    ownerId?: string;
    resourceAttributes: unknown;
    resourceCreatedAt: string;
    resourceCustomAttributes: unknown;
    resourceId?: string;
    resourceLink?: string;
    resourceReloadEndTime?: string;
    resourceReloadStatus?: string;
    resourceSize?: ItemsResourceSizeResponseBody;
    resourceSubType?: string;
    resourceType: ItemResourceTypeEnum;
    resourceUpdatedAt: string;
    spaceId?: string;
    tenantId: string;
    thumbnailId?: string;
    updatedAt: string;
    updaterId?: string;
}
Index

Properties

actions collectionIds createdAt creatorId? description? id isFavorited itemViews? links meta name ownerId? resourceAttributes resourceCreatedAt resourceCustomAttributes resourceId? resourceLink? resourceReloadEndTime? resourceReloadStatus? resourceSize? resourceSubType? resourceType resourceUpdatedAt spaceId? tenantId thumbnailId? updatedAt updaterId?

Properties

actions: string[]

The actions that the user can perform on the item.

collectionIds: string[]

The ID of the collections that the item has been added to.

createdAt: string

The RFC3339 datetime when the item was created.

creatorId?: string

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

description?: string
id: string

The item's unique identifier.

isFavorited: boolean

The flag that indicates if item is in the user's favorites collection.

itemViews?: ItemViewsResponseBody
links: ItemLinksResponseBody
meta: ItemMetaResponseBody

Item metadata and computed fields.

name: string
ownerId?: string

The ID of the user who owns the item.

resourceAttributes: unknown
resourceCreatedAt: string

The RFC3339 datetime when the resource that the item references was created.

resourceCustomAttributes: unknown
resourceId?: string

The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.

resourceLink?: string

The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.

resourceReloadEndTime?: string

The RFC3339 datetime when the resource last reload ended.

resourceReloadStatus?: string

If the resource last reload was successful or not.

resourceSize?: ItemsResourceSizeResponseBody
resourceSubType?: string

Optional field defining the item's subtype, if any.

resourceType: ItemResourceTypeEnum

The case-sensitive string defining the item's type.

resourceUpdatedAt: string

The RFC3339 datetime when the resource that the item references was last updated.

spaceId?: string

The space's unique identifier.

tenantId: string

The ID of the tenant that owns the item. This is populated using the JWT.

thumbnailId?: string

The item thumbnail's unique identifier. This is optional for internal resources.

updatedAt: string

The RFC3339 datetime when the item was last updated.

updaterId?: string

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

Settings

Member Visibility

On This Page

Properties