ApplyPatches method

Overview

Applies a patch to the properties of an object. Allows an update to some of the properties.

It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.

In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties and only a GetLayout call shows the result of the operation.

Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared.

Soft properties apply only to generic objects.

Applying a patch takes less time than resetting all the properties.

Parameters

Name	Description	Type
qPatches	Array of patches.	Array of NxPatch See NxPatch.
qSoftPatch	If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch. This parameter is optional. Default is false.	Boolean

Name

Description

Type

qPatches

Array of patches.

Array of NxPatch

See NxPatch.

qSoftPatch

If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch.

This parameter is optional. Default is false.

Boolean

Name	Description	Type
qOp	Operation to perform.	One of: Add Remove Replace
qPath	Path to the property to add, remove or replace.	String
qValue	This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", "\"New title\""	String

Name

Description

Type

qOp

Operation to perform.

One of:

Add
Remove
Replace

qPath

Path to the property to add, remove or replace.

String

qValue

This parameter is not used in a remove operation.

Corresponds to the value of the property to add or to the new value of the property to update.

Examples:

"false", "2", "\"New title\""

String

Outputs

The following is returned in the output:

"result": {}

Learn more

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here