Ordered Data Stores (Beta)

OrderedDataStores

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

List

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

Paramètres

universeId string

Path

Requis

orderedDataStore string

Path

Requis

scope string

Path

Requis

max_page_size number

page_token string

order_by string

filter string

Requête

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

Réponse

200 - OK

Renvoie une object: ListEntriesResponse

entries array<Entry>

nextPageToken string

Autres codes de statut

Create

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

Paramètres

universeId string

Path

Requis

orderedDataStore string

Path

Requis

scope string

Path

Requis

id string

Requis

CreateEntryRequest CreateEntryRequest

Body

Requis

Requête

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

Réponse

200 - OK

Renvoie une object: Entry

path string

id string

value number

Autres codes de statut

Get

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

Paramètres

universeId string

Path

Requis

orderedDataStore string

Path

Requis

scope string

Path

Requis

entry string

Path

Requis

Requête

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

Réponse

200 - OK

Renvoie une object: Entry

path string

id string

value number

Autres codes de statut

Delete

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

Paramètres

universeId string

Path

Requis

orderedDataStore string

Path

Requis

scope string

Path

Requis

entry string

Path

Requis

Requête

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

Réponse

Autres codes de statut

Update

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

Paramètres

universeIdId string

Path

Requis

orderedDataStore string

Path

Requis

scope string

Path

Requis

entry string

Path

Requis

UpdateEntryRequest UpdateEntryRequest

Body

Requis

allow_missing boolean

Requête

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

Réponse

200 - OK

Renvoie une object: Entry

path string

id string

value number

Autres codes de statut

Increment

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

Paramètres

universeId string

Path

Requis

orderedDataStore string

Path

Requis

scope string

Path

Requis

entry string

Path

Requis

incrementEntryRequest IncrementEntryRequest

Body

Requis

Requête

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

Réponse

200 - OK

Renvoie une object: Entry

path string

id string

value number

Autres codes de statut

Objets

Les objets suivants décrivent les charges utiles qui sont acceptées ou renvoyées. Voir chaque point de terminaison individuel pour plus d'informations sur l'utilisation de ces objets.

Entry

Attributs

path string

Requis

id string

Requis

value number

Requis

IncrementEntryRequest

Attributs

amount number

Requis

UpdateEntryRequest

Attributs

value number

Requis

CreateEntryRequest

Attributs

value number

Requis

ListEntriesResponse

Attributs

entries array<Entry>

Requis

nextPageToken string

Requis