Type Alias ChangeStoresAPI

type ChangeStoresAPI = {
    clearCache: typeof changeStores.clearCache;
    getChangeStore: typeof getChangeStore;
    getChangeStoreChanges: typeof getChangeStoreChanges;
    getChangeStoreChangesTabularViews: typeof getChangeStoreChangesTabularViews;
    getChangeStoreEditableColumns: typeof getChangeStoreEditableColumns;
    getChangeStores: typeof getChangeStores;
}
Index

Properties

clearCache getChangeStore getChangeStoreChanges getChangeStoreChangesTabularViews getChangeStoreEditableColumns getChangeStores

Properties

clearCache: typeof changeStores.clearCache

Clears the cache for change-stores api requests.

getChangeStore: typeof getChangeStore

Returns detailed information about a specific change store, such as its configuration and associated charts.

getChangeStore(
  "507f1f77bcf86cd799439011"
)

The id of the change store.

GetChangeStoreHttpError

getChangeStoreChanges: typeof getChangeStoreChanges

Returns a list of changes within the specified change-store.

getChangeStoreChanges(
  "507f1f77bcf86cd799439011",
  {
    page: "1a2b3c",
    limit: 100,
    sort: "+createdAt"
  }
)

The id of the change store.

an object with query parameters

GetChangeStoreChangesHttpError

getChangeStoreChangesTabularViews: typeof getChangeStoreChangesTabularViews

Returns changes in tabular format, showing modified rows with optional expansion to include all columns.

getChangeStoreChangesTabularViews(
  "507f1f77bcf86cd799439011",
  {
    page: "1a2b3c",
    limit: 100
  }
)

The id of the change store.

an object with query parameters

GetChangeStoreChangesTabularViewsHttpError

getChangeStoreEditableColumns: typeof getChangeStoreEditableColumns

Returns a paginated list of editable-columns that belong to the specified change store, supporting optional filtering and sorting.

getChangeStoreEditableColumns(
  "507f1f77bcf86cd799439011",
  {
    page: "1a2b3c",
    limit: 100,
    sort: "+createdAt"
  }
)

The id of the change store.

an object with query parameters

GetChangeStoreEditableColumnsHttpError

getChangeStores: typeof getChangeStores

Returns a list of change-stores, accessible to the user.

getChangeStores(
  {
    page: "1a2b3c",
    limit: 100,
    sort: "+storeName",
    spaceId: "personal"
  }
)

an object with query parameters

GetChangeStoresHttpError

Settings

Member Visibility

On This Page

Properties