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
Obligatorio
orderedDataStore string
Path
Obligatorio
scope string
Path
Obligatorio
max_page_size number
page_token string
order_by string
filter string

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
entries array<object>
nextPageToken string

Create

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

Parámetros

universeId string
Path
Obligatorio
orderedDataStore string
Path
Obligatorio
scope string
Path
Obligatorio
id string
Obligatorio
CreateEntryRequest object
Body
Obligatorio

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
path string
id string
value number

Get

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

Parámetros

universeId string
Path
Obligatorio
orderedDataStore string
Path
Obligatorio
scope string
Path
Obligatorio
entry string
Path
Obligatorio

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
path string
id string
value number

Delete

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

Parámetros

universeId string
Path
Obligatorio
orderedDataStore string
Path
Obligatorio
scope string
Path
Obligatorio
entry string
Path
Obligatorio

Solicitud

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

Respuesta

Update

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

Parámetros

universeIdId string
Path
Obligatorio
orderedDataStore string
Path
Obligatorio
scope string
Path
Obligatorio
entry string
Path
Obligatorio
UpdateEntryRequest object
Body
Obligatorio
allow_missing boolean

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
path string
id string
value number

Increment

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

Parámetros

universeId string
Path
Obligatorio
orderedDataStore string
Path
Obligatorio
scope string
Path
Obligatorio
entry string
Path
Obligatorio
incrementEntryRequest object
Body
Obligatorio

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
path string
id string
value number

Objetos

Los siguientes objetos describen cargas que son aceptadas o devueltas. Ve cada extremo para más información sobre cuándo se utilizan estos objetos.

Entry

Atributos

path string
id string
value number

IncrementEntryRequest

Atributos

amount number

UpdateEntryRequest

Atributos

value number

CreateEntryRequest

Atributos

value number

ListEntriesResponse

Atributos

entries array<object>
nextPageToken string