applyPatches method
Last updated: 2026-10-27
Information noteSTABLE.
This API is reliable and breaking changes are unlikely.
This API is reliable and breaking changes are unlikely.
backendApi.applyPatches(qPatches, qSoftPatch)
Updates the properties for this object.
Version history
| Version state | Description |
|---|---|
| Introduced | 1.0 |
Parameters
qPatches
Type: Array
Array of patches. Each path contains:
- qOp: Add/Remove/Replace
- qPath: Path to property
- qValue: The new value in string format. Strings need to be surrounded by \".
qSoftPatch
Type: Boolean
Set to True if properties should be soft, that is not persisted.
Returns
A promise of a Qlik associative engine reply.
Tip noteFor more information regarding a promise, see The Promise API.
Example
this.backendApi.applyPatches([
{
"qPath": "/qListObjectDef/qDef/qSortCriterias/0/qSortByLoadOrder",
"qOp": "replace",
"qValue": "-1"
},
{
"qPath": "/meta",
"qOp": "add",
"qValue": "{ \"data\": \"this is the data\"}"
}
], true);