Ordered Data Stores (Beta)

OrderedDataStores

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

List

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

パラメータ

universeId string
Path
必須
orderedDataStore string
Path
必須
scope string
Path
必須
max_page_size number
page_token string
order_by string
filter string

リクエスト

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

レスポンス

200 - OK
OK
以下を返す: object
entries array<object>
nextPageToken string

Create

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

パラメータ

universeId string
Path
必須
orderedDataStore string
Path
必須
scope string
Path
必須
id string
必須
CreateEntryRequest object
Body
必須

リクエスト

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

レスポンス

200 - OK
OK
以下を返す: object
path string
id string
value number

Get

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

パラメータ

universeId string
Path
必須
orderedDataStore string
Path
必須
scope string
Path
必須
entry string
Path
必須

リクエスト

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

レスポンス

200 - OK
OK
以下を返す: object
path string
id string
value number

Delete

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

パラメータ

universeId string
Path
必須
orderedDataStore string
Path
必須
scope string
Path
必須
entry string
Path
必須

リクエスト

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

レスポンス

Update

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

パラメータ

universeIdId string
Path
必須
orderedDataStore string
Path
必須
scope string
Path
必須
entry string
Path
必須
UpdateEntryRequest object
Body
必須
allow_missing boolean

リクエスト

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

レスポンス

200 - OK
OK
以下を返す: object
path string
id string
value number

Increment

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

パラメータ

universeId string
Path
必須
orderedDataStore string
Path
必須
scope string
Path
必須
entry string
Path
必須
incrementEntryRequest object
Body
必須

リクエスト

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

レスポンス

200 - OK
OK
以下を返す: object
path string
id string
value number

オブジェクト

以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。

Entry

属性

path string
id string
value number

IncrementEntryRequest

属性

amount number

UpdateEntryRequest

属性

value number

CreateEntryRequest

属性

value number

ListEntriesResponse

属性

entries array<object>
nextPageToken string