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

Get Memory Store Sorted Map Item

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

Endpoint

Method: GET

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

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.
item_id	path	true	The item ID.

[
  {
    "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": "item_id",
    "in": "path",
    "description": "The item ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

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

Authentication

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

MemoryStoreSortedMapItem

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Get Memory Store Sorted Map Item",
  "description": "Gets and returns the value of the given key in the map.",
  "operationId": "Cloud_GetMemoryStoreSortedMapItem",
  "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": "item_id",
      "in": "path",
      "description": "The item ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MemoryStoreSortedMapItem"
          }
        }
      }
    }
  },
  "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"
    }
  }
}