incrementOrderedDatastoreEntry
Increments the specified entry.
Parameters
Name | Type | Description |
---|---|---|
universeId | UniverseId | The identifier of the experience with ordered data stores that you want to access. |
orderedDataStore | OrderedDataStore | The name of the target ordered data store. |
scope | Scope | The name of the data store scope. |
id | Id | The id of the entry. |
incrementBy | Identifier | The number to increment the entry's value by. |
createIfNoEntryExists? | boolean | The flag to allow the creation of an entry if the entry doesn't exist. (allow_missing) |
Example
const { data: incrementedEntry } = await OrderedDataStoresApi_V1.incrementOrderedDatastoreEntry({
universeId: 5097539509,
orderedDataStore: "PointsStore",
scope: "global",
id: "45348281",
incrementBy: 26,
createIfNoEntryExists: true,
});
Example Data
{
path: "universes/5097539509/orderedDataStores/PointsStore/scopes/global/entries/45348281",
value: 66,
id: "45348281",
}
Endpoint
GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries