Ordered Data Stores (Beta)

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

List

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Parametri

universeId string
Path
Necessario
orderedDataStore string
Path
Necessario
scope string
Path
Necessario
max_page_size number
page_token string
order_by string
filter string

Richiesta

curl

curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \
--header 'x-api-key: <insert-api-key>'

Risposta

200 - OK
OK
Ritorna un(a) object: ListEntriesResponse
entries array<Entry>
nextPageToken string

Create

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Parametri

universeId string
Path
Necessario
orderedDataStore string
Path
Necessario
scope string
Path
Necessario
id string
Necessario
CreateEntryRequest CreateEntryRequest
Body
Necessario

Richiesta

curl

curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": <long>
}'

Risposta

200 - OK
OK
Ritorna un(a) object: Entry
path string
id string
value number

Get

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Parametri

universeId string
Path
Necessario
orderedDataStore string
Path
Necessario
scope string
Path
Necessario
entry string
Path
Necessario

Richiesta

curl

curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>'

Risposta

200 - OK
OK
Ritorna un(a) object: Entry
path string
id string
value number

Delete

DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Parametri

universeId string
Path
Necessario
orderedDataStore string
Path
Necessario
scope string
Path
Necessario
entry string
Path
Necessario

Richiesta

curl

curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>'

Risposta

Update

PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Parametri

universeIdId string
Path
Necessario
orderedDataStore string
Path
Necessario
scope string
Path
Necessario
entry string
Path
Necessario
UpdateEntryRequest UpdateEntryRequest
Body
Necessario
allow_missing boolean

Richiesta

curl

curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": <long>
}'

Risposta

200 - OK
OK
Ritorna un(a) object: Entry
path string
id string
value number

Increment

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

Parametri

universeId string
Path
Necessario
orderedDataStore string
Path
Necessario
scope string
Path
Necessario
entry string
Path
Necessario
incrementEntryRequest IncrementEntryRequest
Body
Necessario

Richiesta

curl

curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": <long>
}'

Risposta

200 - OK
OK
Ritorna un(a) object: Entry
path string
id string
value number

Oggetti

Gli oggetti seguenti descrivono i payloads accettati o restituiti. Per maggiori informazioni su quando vengono utilizzati questi oggetti, consultare ogni singolo endpoint.

Entry

Attributi

path string
Necessario
id string
Necessario
value number
Necessario

IncrementEntryRequest

Attributi

amount number
Necessario

UpdateEntryRequest

Attributi

value number
Necessario

CreateEntryRequest

Attributi

value number
Necessario

ListEntriesResponse

Attributi

entries array<Entry>
Necessario
nextPageToken string
Necessario