Cloud APIs
MemoryStoresApi
listSortedMapItems

listSortedMapItems

Lists items of a sorted map.

Parameters

NameTypeDescription
universeIdIdentifierThe id of the universe to get the sorted map item from.
sortedMapstringThe sorted map to get the item from.
maxPageSize?numberThe id of the item to get.
orderBy?"asc" | "desc"The order of the returned sorted map items.
filter?stringfilter returned sorted map items.

Example

const { data: items } = await MemoryStoresApi.listSortedMapItems<Item>({
  universeId: 5243626809,
  sortedMap: "MySortedMap",
  maxPageSize: 1,
}); 

Example Data

[
  {
    path: "cloud/v2/universes/5243626809/memory-store/sorted-maps/MySortedMap/items/Testing123",
    value: { isReal: true },
    etag: "24",
    expireTime: 2024-04-18T04:31:14.000Z,
    id: "Testing123",
    numericSortKey: 1,
  },
] 

Endpoint

GET /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items