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

List Memory Store Sorted Map Items

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

Endpoint

Method: GET

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

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
sorted_map_id	path	true	The sorted-map ID.
maxPageSize	query	false	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.
pageToken	query	false	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.
orderBy	query	false	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"
filter	query	false	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"`

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "sorted_map_id",
    "in": "path",
    "description": "The sorted-map ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "maxPageSize",
    "in": "query",
    "description": "The maximum number of memory store sorted map items to return. The service\nmight return fewer than this value. If unspecified, at most 1 memory store\nsorted map items are returned. The maximum value is 100 and higher values\nare set to 100.",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "examples": {
      "maxPageSize": {
        "description": "An integer between 1 and 100, inclusive",
        "value": 1
      }
    }
  },
  {
    "name": "pageToken",
    "in": "query",
    "description": "A page token, received from a previous call, to retrieve a subsequent page.\n\nWhen paginating, all other parameters provided to the subsequent call must\nmatch the call that provided the page token.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "orderBy",
    "in": "query",
    "description": "If specified, results are ordered according to the specified fields.\n\nValues must be a comma-separated list of fields, with an optional,\nper-field \" desc\" suffix to sort by descending rather than ascending\nvalues. You can access subfields with a `.` operator.\n\nResults may be ordered by the following fields: id.\n\nExample: \"id desc\"\n",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "filter",
    "in": "query",
    "description": "This field may be set in order to filter the resources returned.\n\nFiltering conforms to Common Expression Language (CEL). Only the `id`\nand `sortKey` fields are supported. In terms of operators, only `<`, `>`\nand `&&` are allowed'\n\nExample: `id > \"key-001\" && id < \"key-100\"`",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ListMemoryStoreSortedMapItemsResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "List Memory Store Sorted Map Items",
  "description": "Gets and returns items in the map with a given order and filter.",
  "operationId": "Cloud_ListMemoryStoreSortedMapItems",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sorted_map_id",
      "in": "path",
      "description": "The sorted-map ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "maxPageSize",
      "in": "query",
      "description": "The maximum number of memory store sorted map items to return. The service\nmight return fewer than this value. If unspecified, at most 1 memory store\nsorted map items are returned. The maximum value is 100 and higher values\nare set to 100.",
      "schema": {
        "type": "integer",
        "format": "int32"
      },
      "examples": {
        "maxPageSize": {
          "description": "An integer between 1 and 100, inclusive",
          "value": 1
        }
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "A page token, received from a previous call, to retrieve a subsequent page.\n\nWhen paginating, all other parameters provided to the subsequent call must\nmatch the call that provided the page token.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "orderBy",
      "in": "query",
      "description": "If specified, results are ordered according to the specified fields.\n\nValues must be a comma-separated list of fields, with an optional,\nper-field \" desc\" suffix to sort by descending rather than ascending\nvalues. You can access subfields with a `.` operator.\n\nResults may be ordered by the following fields: id.\n\nExample: \"id desc\"\n",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "This field may be set in order to filter the resources returned.\n\nFiltering conforms to Common Expression Language (CEL). Only the `id`\nand `sortKey` fields are supported. In terms of operators, only `<`, `>`\nand `&&` are allowed'\n\nExample: `id > \"key-001\" && id < \"key-100\"`",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListMemoryStoreSortedMapItemsResponse"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "memory-store.sorted-map:read"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "memory-store.sorted-map:read"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/MemoryStoreSortedMapItem",
      "name": "MemoryStoreSortedMapItem"
    }
  }
}