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

Devuelve un(a) object: ListEntriesResponse

entries array<Entry>

nextPageToken string

Otros códigos de estado

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 CreateEntryRequest

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

Devuelve un(a) object: Entry

path string

id string

value number

Otros códigos de estado

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

Devuelve un(a) object: Entry

path string

id string

value number

Otros códigos de estado

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

Otros códigos de estado

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 UpdateEntryRequest

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

Devuelve un(a) object: Entry

path string

id string

value number

Otros códigos de estado

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 IncrementEntryRequest

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

Devuelve un(a) object: Entry

path string

id string

value number

Otros códigos de estado

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

Obligatorio

id string

Obligatorio

value number

Obligatorio

IncrementEntryRequest

Atributos

amount number

Obligatorio

UpdateEntryRequest

Atributos

value number

Obligatorio

CreateEntryRequest

Atributos

value number

Obligatorio

ListEntriesResponse

Atributos

entries array<Entry>

Obligatorio

nextPageToken string

Obligatorio