OrderedDataStoreEntry

A key-value entry in an ordered data store.

Attributs

pathstring

The resource path of the ordered data store entry.

Format: universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{ordered_data_store_scope_id}/entries/{ordered_data_store_entry_id}.

valuenumber

The value of the entry.

Always rounded to the nearest integer.

idstring
Sortie seule

The name of the entry.

URL de base
https://apis.roblox.com
La ressource OrderedDataStoreEntry
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

List Ordered Data Store Entries
Bêta

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

Returns a list of entries from an ordered data store.

Périmètres d'application
universe.ordered-data-store.scope.entry:read
RequêteParamètres du chemin
universe_idstring
Requis

The universe ID.

ordered_data_store_idstring
Requis

The ordered-data-store ID.

scope_idstring
Requis

The scope ID.

Paramètres de requête
maxPageSizenumber

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.

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: value.

Example: "value desc".

filterstring

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.

Réponse

A list of OrderedDataStoreEntries in the parent collection.

orderedDataStoreEntriesarray<OrderedDataStoreEntry>

The OrderedDataStoreEntries from the specified OrderedDataStoreScope.

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}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries?maxPageSize=10&pageToken={string}&orderBy={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
Réponse
{

  "orderedDataStoreEntries": [

    {

      "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

      "value": "number",

      "id": "string"

    }

  ],

  "nextPageToken": "string"

}

OrderedDataStoreEntry

Create Ordered Data Store Entry
Bêta

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

Creates an entry with the provided ID and value.

Returns a 400 Bad Request if the entry exists.

Périmètres d'application
universe.ordered-data-store.scope.entry:write
RequêteParamètres du chemin
universe_idstring
Requis

The universe ID.

ordered_data_store_idstring
Requis

The ordered-data-store ID.

scope_idstring
Requis

The scope ID.

Paramètres de requête
idstring

The ID to use for the ordered data store entry, which will become the final component of the ordered data store entry's resource path.

This value should be A 1-63 character string. We strongly recommend using only lowercase letters, numeric digits, and hyphens.

Corps de la requêteOrderedDataStoreEntry
RéponseOrderedDataStoreEntry
POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries?id=my-entry' \

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

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

  --data '{

  "value": "number"

}'
Réponse
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

Get Ordered Data Store Entry
Bêta

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

Gets the specified entry.

Périmètres d'application
universe.ordered-data-store.scope.entry:read
RequêteParamètres du chemin
universe_idstring
Requis

The universe ID.

ordered_data_store_idstring
Requis

The ordered-data-store ID.

scope_idstring
Requis

The scope ID.

entry_idstring
Requis

The entry ID.

RéponseOrderedDataStoreEntry
GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}' \

  -H 'x-api-key: {your-api-key}'
Réponse
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

Delete Ordered Data Store Entry
Bêta

DELETE /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

Deletes the specified entry.

On success, returns 200 OK. If the entry doesn't exist, returns 404 Not Found.

Périmètres d'application
universe.ordered-data-store.scope.entry:write
RequêteParamètres du chemin
universe_idstring
Requis

The universe ID.

ordered_data_store_idstring
Requis

The ordered-data-store ID.

scope_idstring
Requis

The scope ID.

entry_idstring
Requis

The entry ID.

DELETE /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}' \

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

OrderedDataStoreEntry

Update Ordered Data Store Entry
Bêta

PATCH /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

Updates the value of an entry.

Périmètres d'application
universe.ordered-data-store.scope.entry:write
RequêteParamètres du chemin
universe_idstring
Requis

The universe ID.

ordered_data_store_idstring
Requis

The ordered-data-store ID.

scope_idstring
Requis

The scope ID.

entry_idstring
Requis

The entry ID.

Paramètres de requête
allowMissingboolean

If set to true, and the ordered data store entry is not found, a ordered data store entry is created.

Corps de la requêteOrderedDataStoreEntry
RéponseOrderedDataStoreEntry
PATCH /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}?allowMissing={boolean}' \

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

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

  --data '{

  "value": "number"

}'
Réponse
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

Increment Ordered Data Store Entry
Bêta

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

Increments the value of the specified entry. Both the existing value and the increment amount must be integers.

If the entry doesn't exist, creates an entry with the specified value.

Known issue: the value may be incremented past the valid range of values. When this happens, the returned value will be clamped to the valid range, but the backend may persist the original value. This behavior is maintained for backwards compatibility reasons, but may change in a future version of this API.

Périmètres d'application
universe.ordered-data-store.scope.entry:write
RequêteParamètres du chemin
universe_idstring
Requis

The universe ID.

ordered_data_store_idstring
Requis

The ordered-data-store ID.

scope_idstring
Requis

The scope ID.

entry_idstring
Requis

The entry ID.

Corps de la requête
amountnumber

The amount by which to increment the entry value. Both the existing value and the increment amount must be integers.

RéponseOrderedDataStoreEntry
POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment' \

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

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

  --data '{

  "amount": "number"

}'
Réponse
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}