Ordered Data Stores (Beta)

OrderedDataStores

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

List

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

Parâmetros

universeId string
Path
Obrigatório
orderedDataStore string
Path
Obrigatório
scope string
Path
Obrigatório
max_page_size number
page_token string
order_by string
filter string

Solicitação

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

Resposta

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

Create

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

Parâmetros

universeId string
Path
Obrigatório
orderedDataStore string
Path
Obrigatório
scope string
Path
Obrigatório
id string
Obrigatório
CreateEntryRequest CreateEntryRequest
Body
Obrigatório

Solicitação

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> 

}'

Resposta

200 - OK
OK
Retorna um(a) object: Entry
path string
id string
value number

Get

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

Parâmetros

universeId string
Path
Obrigatório
orderedDataStore string
Path
Obrigatório
scope string
Path
Obrigatório
entry string
Path
Obrigatório

Solicitação

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

Resposta

200 - OK
OK
Retorna um(a) object: Entry
path string
id string
value number

Delete

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

Parâmetros

universeId string
Path
Obrigatório
orderedDataStore string
Path
Obrigatório
scope string
Path
Obrigatório
entry string
Path
Obrigatório

Solicitação

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

Resposta

Update

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

Parâmetros

universeIdId string
Path
Obrigatório
orderedDataStore string
Path
Obrigatório
scope string
Path
Obrigatório
entry string
Path
Obrigatório
UpdateEntryRequest UpdateEntryRequest
Body
Obrigatório
allow_missing boolean

Solicitação

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> 

}'

Resposta

200 - OK
OK
Retorna um(a) object: Entry
path string
id string
value number

Increment

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

Parâmetros

universeId string
Path
Obrigatório
orderedDataStore string
Path
Obrigatório
scope string
Path
Obrigatório
entry string
Path
Obrigatório
incrementEntryRequest IncrementEntryRequest
Body
Obrigatório

Solicitação

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> 

}'

Resposta

200 - OK
OK
Retorna um(a) object: Entry
path string
id string
value number

Objetos

Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.

Entry

Atributos

path string
Obrigatório
id string
Obrigatório
value number
Obrigatório

IncrementEntryRequest

Atributos

amount number
Obrigatório

UpdateEntryRequest

Atributos

value number
Obrigatório

CreateEntryRequest

Atributos

value number
Obrigatório

ListEntriesResponse

Atributos

entries array<Entry>
Obrigatório
nextPageToken string
Obrigatório