Type Alias ItemsAPI

type ItemsAPI = {
    clearCache: typeof clearCache;
    deleteItem: typeof deleteItem;
    getItem: typeof getItem;
    getItemCollections: typeof getItemCollections;
    getItems: typeof getItems;
    getItemsSettings: typeof getItemsSettings;
    getPublishedItems: typeof getPublishedItems;
    patchItemsSettings: typeof patchItemsSettings;
    updateItem: typeof updateItem;
}
Index

Properties

clearCache: typeof clearCache

Clears the cache for items api requests.

deleteItem: typeof deleteItem

Deletes an item and removes the item from all collections.

The item's unique identifier.

DeleteItemHttpError

getItem: typeof getItem

Finds and returns an item.

The item's unique identifier

GetItemHttpError

getItemCollections: typeof getItemCollections

Finds and returns the collections (and tags) of an item. This endpoint does not return the user's favorites collection.

The item's unique identifier.

an object with query parameters

GetItemCollectionsHttpError

getItems: typeof getItems

Lists items that the user has access to.

an object with query parameters

GetItemsHttpError

getItemsSettings: typeof getItemsSettings

Finds and returns the items service settings for the current tenant. Currently used to enable or disable usage metrics in the tenant.

GetItemsSettingsHttpError

getPublishedItems: typeof getPublishedItems

Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.

The item's unique identifier

an object with query parameters

GetPublishedItemsHttpError

patchItemsSettings: typeof patchItemsSettings

Updates the settings provided in the patch body. Currently used to enable or disable usage metrics in the tenant.

an object with the body content

PatchItemsSettingsHttpError

updateItem: typeof updateItem

Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.

The item's unique identifier.

an object with the body content

UpdateItemHttpError