MemoryStoreSortedMapItem

Represents an item within a sorted map structure.

Attributes

pathstring

The resource path of the memory store sorted map item.

Format: universes/{universe_id}/memory-store/sorted-maps/{memory_store_sorted_map_id}/items/{memory_store_sorted_map_item_id}.

valueJSON value

The value of the item.

A JSON value can be null, boolean, string, number, array, or object.

etagstring
Output Only

The server generated tag of an item.

One of the following for expiration:

ttlstring
Input Only

The TTL for the item.

expireTimestring
Output Only

The expiration time of the item. This string is formatted as a Timestamp.

idstring

The name of the item.

One of the following for sortKey:

stringSortKeystring

The item will be sorted lexicographically according to this string.

numericSortKeynumber

The item will be sorted according to this number.

Base URL
https://apis.roblox.com
The MemoryStoreSortedMapItem Resource
{

  "path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",

  "value": "JSON value",

  "etag": "string",

  "ttl": "3s",

  "id": "string",

  "stringSortKey": "string"

}

MemoryStoreSortedMapItem

List Memory Store Sorted Map Items
Beta

GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items

Gets and returns items in the map with a given order and filter.

Scopes
universe.memory-store.sorted-map:read
RequestPath Parameters
universe_idstring
Required

The universe ID.

sorted_map_idstring
Required

The sorted-map ID.

Query Parameters
maxPageSizenumber

The maximum number of memory store sorted map items to return. The service might return fewer than this value. If unspecified, at most 1 memory store sorted map items are returned. The maximum value is 100 and higher values are set to 100.

pageTokenstring

A page token, received from a previous call, to retrieve a subsequent page.

When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.

orderBystring

If specified, results are ordered according to the specified fields.

Values must be a comma-separated list of fields, with an optional, per-field " desc" suffix to sort by descending rather than ascending values. You can access subfields with a . operator.

Results may be ordered by the following fields: id.

Example: "id desc" .

filterstring

This field may be set in order to filter the resources returned.

Filtering conforms to Common Expression Language (CEL). Only the id and sortKey fields are supported. In terms of operators, only <, > and && are allowed'

Example: id > "key-001" && id < "key-100".

Response

A list of MemoryStoreSortedMapItems in the parent collection.

memoryStoreSortedMapItemsarray<MemoryStoreSortedMapItem>

The MemoryStoreSortedMapItems from the specified MemoryStoreSortedMap.

nextPageTokenstring

A token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.

GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items?maxPageSize=1&pageToken={string}&orderBy={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "memoryStoreSortedMapItems": [

    {

      "path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",

      "value": "JSON value",

      "etag": "string",

      "id": "string",

      "stringSortKey": "string"

    }

  ],

  "nextPageToken": "string"

}

MemoryStoreSortedMapItem

Create Memory Store Sorted Map Item
Beta

POST /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items

Creates the specified map item if it doesn't exist.

Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universe_idstring
Required

The universe ID.

sorted_map_idstring
Required

The sorted-map ID.

Query Parameters
idstring

The ID to use for the memory store sorted map item, which will become the final component of the memory store sorted map item's resource path.

This value should be a 1-127 character string that supports alphanumeric and special characters. This id is case sensitive. The id must be url encoded if it contains any url breaking special characters.

Request BodyMemoryStoreSortedMapItem
ResponseMemoryStoreSortedMapItem
POST /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items?id=Hello!' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "value": "JSON value",

  "ttl": "3s",

  "id": "string",

  "stringSortKey": "string"

}'
Response
{

  "path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",

  "value": "JSON value",

  "etag": "string",

  "id": "string",

  "stringSortKey": "string"

}

MemoryStoreSortedMapItem

Get Memory Store Sorted Map Item
Beta

GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}

Gets and returns the value of the given key in the map.

Scopes
universe.memory-store.sorted-map:read
RequestPath Parameters
universe_idstring
Required

The universe ID.

sorted_map_idstring
Required

The sorted-map ID.

item_idstring
Required

The item ID.

ResponseMemoryStoreSortedMapItem
GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",

  "value": "JSON value",

  "etag": "string",

  "id": "string",

  "stringSortKey": "string"

}

MemoryStoreSortedMapItem

Delete Memory Store Sorted Map Item
Beta

DELETE /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}

Deletes the specified item from the map.

Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universe_idstring
Required

The universe ID.

sorted_map_idstring
Required

The sorted-map ID.

item_idstring
Required

The item ID.

DELETE /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}' \

  -H 'x-api-key: {your-api-key}'

MemoryStoreSortedMapItem

Update Memory Store Sorted Map Item
Beta

PATCH /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}

Updates the specified map item.

Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universe_idstring
Required

The universe ID.

sorted_map_idstring
Required

The sorted-map ID.

item_idstring
Required

The item ID.

Query Parameters
allowMissingboolean

If set to true, and the memory store sorted map item is not found, a memory store sorted map item is created.

Request BodyMemoryStoreSortedMapItem
ResponseMemoryStoreSortedMapItem
PATCH /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}?allowMissing={boolean}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "value": "JSON value",

  "ttl": "3s",

  "id": "string",

  "stringSortKey": "string"

}'
Response
{

  "path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",

  "value": "JSON value",

  "etag": "string",

  "id": "string",

  "stringSortKey": "string"

}