GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions — cloud.docs

List Data Store Entry Revisions

List revisions of the data store entry.

This method returns partial data store entries.

In particular, only the path, id, createTime, revisionCreateTime, revisionId, etag, and state fields are populated. Both the path and id fields will have an @<version> suffix.

In order to get the full entry at a revision, you can use the provided path field with the GetDataStoreEntry method, i.e. GET /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
data_store_id	path	true	The data-store ID.
entry_id	path	true	The entry ID.
maxPageSize	query	false	The maximum number of revisions to return per page. The service might return fewer than the maximum number of revisions. If unspecified, at most 10 revisions are returned. The maximum value is 100 values 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.
filter	query	false	Supports the following subset of CEL: * Only the `&&`, `<=`, and `>=` operators are supported. * Only the `revision_create_time` field is supported. For example: `"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z"`

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "data_store_id",
    "in": "path",
    "description": "The data-store ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "entry_id",
    "in": "path",
    "description": "The entry ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "maxPageSize",
    "in": "query",
    "description": "The maximum number of revisions to return per page.\n\nThe service might return fewer than the maximum number of revisions.\nIf unspecified, at most 10 revisions are returned.\nThe maximum value is 100 values and higher values are set 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\nmust match the call that provided the page token.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "filter",
    "in": "query",
    "description": "Supports the following subset of CEL:\n\n* Only the `&&`, `<=`, and `>=` operators are supported.\n* Only the `revision_create_time` field is supported.\n\nFor example:\n\n  `\"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <=\n  2001-01-01T00:00:00Z\"`",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

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

Authentication

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

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "List Data Store Entry Revisions",
  "description": "List revisions of the data store entry.\n\nThis method returns partial data store entries.\n\nIn particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,\n`revisionId`, `etag`, and `state` fields are populated. Both the `path` and\n`id` fields will have an `@<version>` suffix.\n\nIn order to get the full entry at a revision, you can use the provided\n`path` field with the `GetDataStoreEntry` method, i.e. `GET\n/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.",
  "operationId": "Cloud_ListDataStoreEntryRevisions__Using_Universes_DataStores",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "data_store_id",
      "in": "path",
      "description": "The data-store ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "entry_id",
      "in": "path",
      "description": "The entry ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "maxPageSize",
      "in": "query",
      "description": "The maximum number of revisions to return per page.\n\nThe service might return fewer than the maximum number of revisions.\nIf unspecified, at most 10 revisions are returned.\nThe maximum value is 100 values and higher values are set 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\nmust match the call that provided the page token.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "Supports the following subset of CEL:\n\n* Only the `&&`, `<=`, and `>=` operators are supported.\n* Only the `revision_create_time` field is supported.\n\nFor example:\n\n  `\"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <=\n  2001-01-01T00:00:00Z\"`",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListDataStoreEntryRevisionsResponse"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-rate-limits": {
    "description": "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-datastores.versions:list"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe-datastores.versions:list"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/DataStoreEntry",
      "name": "DataStoreEntry"
    }
  }
}