Increment¶

Description¶

This operation increments the value of the specified key by a specific number.

Method¶

PUT

Endpoint URL¶

Important

Make sure to replace xxxx in the domain name in the request specification below to the one assigned to your application.

https://xxxx.backendless.app/api/hive/[hive-name]/map/[key]/increment/[key-name]?count=[increment-by]

where:

Argument	Description
`[hive-name]`	Name of a hive where the operation is performed.
`[key]`	Key name identifying a map.
`[key-name]`	Key name identifying a key-value pair.
`[increment-by]`	A number to increment a value by. Defaults to 1.

Request Headers¶

Content-Type:application/json

where:

Argument	Description
`Content-Type`	Must be set to `application/json`. This header is mandatory.

Request Body¶

None.

Response Body¶

The incremented value.

Examples¶

Increment The Value By n + 1

The example below increments the value of the key Apples by 1. When this operation is used without the count parameter, then the value is always incremented by 1 for every request made.

curl --location --request PUT "https://xxxx.backendless.app/api/hive/groceryStore/map/fruits/increment/Apples"

where:

Argument	Description
`groceryStore`	Name of a hive where the operation is performed.
`fruits`	Key name identifying a map.

Increment The Value By A Number

The example below increments the value of the key Apples by 5.

curl --location --request PUT "https://xxxx.backendless.app/api/hive/groceryStore/map/fruits/increment/Apples?count=5"

where:

Argument	Description
`groceryStore`	Name of a hive where the operation is performed.
`fruits`	Key name identifying a map.

Codeless Reference¶

map_api_increment

where:

Argument	Description
`hive name`	Name of a hive where the operation is performed.
`key name`	Key name identifying a map.
`object key name`	Key name identifying a key-value pair.
`increment by`	Specify the number to increment the value of the specified key.

Returns the incremented value.

Consider the following Map storage:
map_apI_example_map_store_6

The example below increments the value of the key "Apples" by 5.

map_api_example_increment

The map will look as shown below after the Codeless logic runs:
map_apI_example_map_store_7