OrderedDataStoreEntry

Attributes

pathstring
valuenumber
idstring
Output Only
Base URL
https://apis.roblox.com/cloud
The OrderedDataStoreEntry Resource
{

  "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
Beta

GET /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries
Scopes
universe.ordered-data-store.scope.entry:read
RequestPath Parameters
universestring
Required
ordered-data-storestring
Required
scopestring
Required
Query Parameters
maxPageSizenumber
pageTokenstring
orderBystring
filterstring
Response
nextPageTokenstring
GET /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries?maxPageSize=10&pageToken={string}&orderBy={string}&filter={string}' \

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

  "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
Beta

POST /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries
Scopes
universe.ordered-data-store.scope.entry:write
RequestPath Parameters
universestring
Required
ordered-data-storestring
Required
scopestring
Required
Query Parameters
idstring
Request BodyOrderedDataStoreEntry
ResponseOrderedDataStoreEntry
POST /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries?id=my-entry' \

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

  --data '{ \

  "value": "number" \

}'
Response
{

  "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
Beta

GET /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}
Scopes
universe.ordered-data-store.scope.entry:read
RequestPath Parameters
universestring
Required
ordered-data-storestring
Required
scopestring
Required
entrystring
Required
ResponseOrderedDataStoreEntry
GET /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}' \

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

  "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
Beta

DELETE /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}
Scopes
universe.ordered-data-store.scope.entry:write
RequestPath Parameters
universestring
Required
ordered-data-storestring
Required
scopestring
Required
entrystring
Required
DELETE /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}' \

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

OrderedDataStoreEntry

Update Ordered Data Store Entry
Beta

PATCH /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}
Scopes
universe.ordered-data-store.scope.entry:write
RequestPath Parameters
universestring
Required
ordered-data-storestring
Required
scopestring
Required
entrystring
Required
Query Parameters
allowMissingboolean
Request BodyOrderedDataStoreEntry
ResponseOrderedDataStoreEntry
PATCH /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}?allowMissing={boolean}' \

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

  --data '{ \

  "value": "number" \

}'
Response
{

  "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
Beta

POST /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}:increment
Scopes
universe.ordered-data-store.scope.entry:write
RequestPath Parameters
universestring
Required
ordered-data-storestring
Required
scopestring
Required
entrystring
Required
Request Body
amountnumber
ResponseOrderedDataStoreEntry
POST /cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}:increment
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe}/ordered-data-stores/{ordered-data-store}/scopes/{scope}/entries/{entry}:increment' \

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

  --data '{ \

  "amount": "number" \

}'
Response
{

  "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"

}