POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment — cloud.docs

Increment Ordered Data Store Entry

Increments the value of the specified entry. Both the existing value and the increment amount must be integers.

If the entry doesn't exist, creates an entry with the specified value.

Known issue: the value may be incremented past the valid range of values. When this happens, the returned value will be clamped to the valid range, but the backend may persist the original value. This behavior is maintained for backwards compatibility reasons, but may change in a future version of this API.

Endpoint

Method: POST

Path: /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
ordered_data_store_id	path	true	The ordered-data-store ID.
scope_id	path	true	The scope ID.
entry_id	path	true	The entry ID.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "ordered_data_store_id",
    "in": "path",
    "description": "The ordered-data-store ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "scope_id",
    "in": "path",
    "description": "The scope ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "entry_id",
    "in": "path",
    "description": "The entry ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/IncrementOrderedDataStoreEntryRequest"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrderedDataStoreEntry"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Increment Ordered Data Store Entry",
  "description": "Increments the value of the specified entry. Both the existing value and\nthe increment amount must be integers.\n\nIf the entry doesn't exist, creates an entry with the specified value.\n\nKnown issue: the value may be incremented past the valid range of  values.\nWhen this happens, the returned value will be clamped to the valid range,\nbut the backend may persist the original value. This behavior is maintained\nfor backwards compatibility reasons, but may change in a future version of\nthis API.",
  "operationId": "Cloud_IncrementOrderedDataStoreEntry",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "ordered_data_store_id",
      "in": "path",
      "description": "The ordered-data-store ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "scope_id",
      "in": "path",
      "description": "The scope ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "entry_id",
      "in": "path",
      "description": "The entry ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/IncrementOrderedDataStoreEntryRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrderedDataStoreEntry"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-rate-limits": {
    "description": "Ordered data stores requests are subject to additional throttling limits described in the [Open Cloud guide for data stores](https://create.roblox.com/docs/cloud/guides/data-stores/throttling)."
  },
  "x-roblox-scopes": [
    {
      "name": "universe.ordered-data-store.scope.entry:write"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe.ordered-data-store.scope.entry:write"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/OrderedDataStoreEntry",
      "name": "OrderedDataStoreEntry"
    }
  }
}