IncrementDataStoreEntryRequest — openapi

Increments the entry value.

If the value is not numeric, this request fails.

Properties

Name	Type	Required	Description
amount	number	false	The amount by which to increment the entry value. Both the existing value and the increment amount must be integers.
users	array	false	Users associated with the entry. Each value must be a user resource path in the format `users/{user_id}`, not a bare user ID. If this is not provided, existing user IDs are cleared.
attributes	object	false	An arbitrary set of attributes associated with the entry. If this is not provided, existing attributes are cleared.

Complete Schema

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "description": "The amount by which to increment the entry value. Both the existing value\nand the increment amount must be integers.",
      "format": "double"
    },
    "users": {
      "example": "users/123",
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Users associated with the entry.\n\nEach value must be a user resource path in the format `users/{user_id}`,\nnot a bare user ID.\n\nIf this is not provided, existing user IDs are cleared."
    },
    "attributes": {
      "type": "object",
      "description": "An arbitrary set of attributes associated with the entry.\n\nIf this is not provided, existing attributes are cleared."
    }
  },
  "description": "Increments the entry value.\n\nIf the value is not numeric, this request fails.",
  "x-oneOf": {
    "Amount": [
      "amount"
    ]
  }
}