GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries — cloud.docs

List Ordered Data Store Entries

Returns a list of entries from an ordered data store.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
ordered_data_store_id	path	true	The ordered-data-store ID.
scope_id	path	true	The scope ID.
maxPageSize	query	false	The maximum number of ordered data store entries to return. The service might return fewer than this value. If unspecified, at most 10 ordered data store entries 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: value. Example: "value desc"
filter	query	false	This field may be set in order to filter the resources returned. We support two comparison operators for this operation: `<=` and `>=`.These comparison operators act as a minValue and maxValue for the values returned. If filtering is needed for a value between a minValue and maxValue the user can use the logical operator `&&`. All tokens in the filter expression must be separated by a single space. Example filters: `entry <= 10`; `entry >= 10 && entry <= 30`

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "ordered_data_store_id",
    "in": "path",
    "description": "The ordered-data-store ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "scope_id",
    "in": "path",
    "description": "The scope ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "maxPageSize",
    "in": "query",
    "description": "The maximum number of ordered data store entries to return. The service\nmight return fewer than this value. If unspecified, at most 10 ordered data\nstore entries are returned. The maximum value is 100 and higher values are\nset to 100.",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "examples": {
      "maxPageSize": {
        "description": "An integer between 1 and 100, inclusive",
        "value": 10
      }
    }
  },
  {
    "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: value.\n\nExample: \"value desc\"\n",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "filter",
    "in": "query",
    "description": "This field may be set in order to filter the resources returned.\n\nWe support two comparison operators for this operation: `<=` and `>=`.These\ncomparison operators act as a minValue and maxValue for the values\nreturned. If filtering is needed for a value between a minValue and\nmaxValue the user can use the logical operator `&&`. All tokens in the\nfilter expression must be separated by a single space.\n\nExample filters: `entry <= 10`; `entry >= 10 && entry <= 30`",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

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

Authentication

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

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "List Ordered Data Store Entries",
  "description": "Returns a list of entries from an ordered data store.",
  "operationId": "Cloud_ListOrderedDataStoreEntries",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "ordered_data_store_id",
      "in": "path",
      "description": "The ordered-data-store ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "scope_id",
      "in": "path",
      "description": "The scope ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "maxPageSize",
      "in": "query",
      "description": "The maximum number of ordered data store entries to return. The service\nmight return fewer than this value. If unspecified, at most 10 ordered data\nstore entries are returned. The maximum value is 100 and higher values are\nset to 100.",
      "schema": {
        "type": "integer",
        "format": "int32"
      },
      "examples": {
        "maxPageSize": {
          "description": "An integer between 1 and 100, inclusive",
          "value": 10
        }
      }
    },
    {
      "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: value.\n\nExample: \"value desc\"\n",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "This field may be set in order to filter the resources returned.\n\nWe support two comparison operators for this operation: `<=` and `>=`.These\ncomparison operators act as a minValue and maxValue for the values\nreturned. If filtering is needed for a value between a minValue and\nmaxValue the user can use the logical operator `&&`. All tokens in the\nfilter expression must be separated by a single space.\n\nExample filters: `entry <= 10`; `entry >= 10 && entry <= 30`",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListOrderedDataStoreEntriesResponse"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-rate-limits": {
    "description": "Ordered data stores requests are subject to additional throttling limits described in the [Open Cloud guide for data stores](https://create.roblox.com/docs/cloud/guides/data-stores/throttling)."
  },
  "x-roblox-scopes": [
    {
      "name": "universe.ordered-data-store.scope.entry:read"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe.ordered-data-store.scope.entry:read"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/OrderedDataStoreEntry",
      "name": "OrderedDataStoreEntry"
    }
  }
}