Skip to content

Conditional update

Atomically sets the value to the given updated value if the current value == the expected value.

Method:

PUT

URL

https://api.backendless.com/<application-id>/<REST-api-key>/  
                           counters/<counterName>/get/compareandset?  
                           expected=<expected>&updatedvalue=<updated>

where:

Argument                Description
<application id> ID of the application which can be obtained from the Manage > App Settings screen of the Backendless Console
<REST-api-key> REST API key of your application. You can get the value from the Manage > App Settings section of the Backendless Console.
<counterName> name of the counter to update.
<expected> the expected value of the counter. If the current value equals the expected value, the counter is set to the "updated" value.
<updated> the new value to assign to the counter if the current value equals the expected value.

Request headers

user-token: optional value obtained as a result of the login operation.

where:

Argument                Description
user-token Optional header. Contains a value returned by Backendless in a preceding user Login API call. If user-token is set in the request, the currently logged in user will be assigned to the ownerId property of the user object which is being saved.  Additionally, the operation will be executed with the security policy associated currently logged in user. This means all permissions associated with the user and the roles assigned to the user will be enforced by Backendless.

Request body

N/A

Response body

Boolean value - true if the counter has been updated, false otherwise

Example

curl -X PUT \  
https://api.backendless.com/XXXX-XXXX-XXXX/ZZZZ-ZZZZ-ZZZZ/counters/mycounter/get/compareandset?expected=1000&updatedvalue=2000