Update Record
Update an existing record.
Recipes
Add/remove value from record array
Add/remove value from record array
1. Set an update operator for an array field to add values to the array
Apply an add_to_set
operator to an array field to add values to the array. Here, the add_to_set
operator is applied to the films
field with new values that should be added to the array.
2. Set an update operator for another array field to remove values from the array
Apply a pull
operator to the array field to remove values from the array. Here, the pull
operator is applied to the ratings
field with the values that should be removed from its array.
3. As a result, the API returns the updated record.
The specified values are added to the films
array and removed from the ratings
array.
Increment/append value of record array
Increment/append value of record array
1. Set an update operator for an array field to increment values of an array
Apply the inc
operator to an array field to increment its values. Here, the inc
operator is applied to the score_value
and progress
fields.
2. Set an update operator for another array field to append values to it
Apply a push
operator to the array to append values to it. Here, the push
operator is applied to the completed_levels
field with the values that should be appended.
3. As a result, the API returns the updated record.
The 4
value is appended to the completed_levels
array while the score_value
and progress
values are incremented by the 20
and 0.11
.
Update record array element by index
Update record array element by index
1. Set an array element
Set an array element that should be updated.
2. As a result, the API returns an updated array.
The 1st element of the movie
array is updated to Titanic
.
Update record
Update record
1. Set a new value for a field
You can update a value of the field. Here, the game_mode_name
field is set to rainbow dash
.
2. As a result, the API returns an updated record.
To update the existing record you should know the record ID and use a PUT
request with application/json
or
application/x-www-form-urlencoded
content type of PUT/POST body. Received values will be casted according to
the class defined in QuickBlox Dashboard.
A field that is present in class but not specified in the PUT request has a null
value. To nullify
the existing value you should specify null
for application/x-www-/form-urlencoded
, and null
for application/json
content type.
An update request updates specified fields only (other fields will be left untouched).
For numeric fields Integer
and Float
, there is a special increment operator inc
that increments or decrements the numeric field.
Update operators
The request can contain next update operators:
Operator | Description |
---|---|
inc | Types: integer, float Example: inc[field1]=1000 Increment field <field_name> to a specified value. The value can be positive or negative(decrement operation). |
pull | Types: arrays Example: pull[field1]=val1 Removes a specified value from the array field. |
pull with filter | Types: arrays Example: pull[field1][<filter_operator>]=<filter_value> Removes all elements filtered by filter operator from the array. |
pull_all | Types: arrays Example: pull_all[field1][]=val1&pull_all[field1][]=val2 Removes all specified values from the array. |
pop | Types: arrays Example: pop[field1]=1 Removes the last element from the array. To remove the first, the element value should be equal to 1. |
push | Types: arrays Example: push[field1][]=val1&push[field1][]=val2 Appends specified values to the array. |
add_to_set | Types: arrays Example: add_to_set[<field_name>]= Adds a value to the array only if the value is not in the array already. |
Update array element by index operator | Type: arrays Example: <field_name>[<index>]=val Update the array element by index. |
Search operators
The request can contain all, some or none of the next search operators:
Operator | Description |
---|---|
lt | Less Than operator Types:integer, float Example: score_value[lt]=1000 |
lte | Less Than or Equal to operator Types: integer, float Example: score_value[lte]=850 |
gt | Greater Than operator Types: integer, float Example: bonus_count[gt]=2.45 |
gte | Greater Than or Equal to operator Types: integer, float Example: bonus_count[gte]=56.443 |
ne | Not Equal to operator Types: integer, float, string, boolean Example: game_mode_name[ne]=ctf |
in | Contained IN array operator Types: integer, float, string Example: game_mode_name[in]=deathmatch,rage |
nin | Not contained IN array operator Types: integer, float, string Example: game_mode_name[nin]=survivor,crazy_nightmare |
all | ALL contained IN array operator Types: array Example: game_modes[all]=survivo,crazy |
or | OR operator Types: integer, float, string Example: name[or]=sam,tim name[or]=sam&lastname[or]=johnson Will return records with name sam or tim . Will return records with name sam or last name johnson . |
ctn | Contains substring operator Types: string Example: username[ctn]=son Will return all records where username field contains son substring. |
near | Types: location Example: mylocation[near]=25.32,44.551;1000 Search records in a specific radius with the current position in meters. Format: {field_name}[near]=longitude,latitude;radius . |
Path Parameters
Custom object class name.
ID of the custom object record. Generated automatically by the server after record creation.
Body Parameters
Update a value to the field defined in Custom Object class.
Update the array element by index. Update Operators.
Example: cartoons[1]=Aladdin
.