Skip to content

GenericBookmark

QIX methods for version 12.251.0.

Apply

Applies a bookmark.

The operation is successful if qSuccess is set to true.

No parameters.

Returns:

Name Type Description
qSuccess boolean <true or false>

ApplyPatches

Applies a patch to the properties of an object. Allows an update to some of the properties.
Applying a patch takes less time than resetting all the properties.

Required permissions: update

Parameters:

Name Type Mandatory Description
qPatches NxPatch Yes Array of patches.

No return values.

Approve

Adds the generic bookmark to the list of approved objects
This operation is possible only in Qlik Sense Enterprise.

Required permissions: approve

No parameters.

No return values.

GetFieldValues

Retrieves the values of a field.

Parameters:

Name Type Mandatory Description
qField string Yes Name of the field.
qGetExcludedValues boolean Yes If set to true, only excluded values are returned.
qDataPage BookmarkFieldPage Yes Range of returned values.

Returns:

Name Type Description
qFieldValues array<FieldValue> The field values from a defined range.

GetInfo

Returns:
- The type of the object.
- The identifier of the object.

No parameters.

Returns:

Name Type Description
qInfo NxInfo {"qId":"<identifier>","qType":"<type>"}

GetLayout

Evaluates an object and displays its properties including the dynamic properties.
If the member delta is set to true in the request object, only the delta is evaluated.

No parameters.

Returns:

Name Type Description
qLayout GenericBookmarkLayout Information on the object.

GetProperties

Shows the properties of an object.
If the member delta is set to true in the request object, only the delta is retrieved.
The following is always returned in the output:

No parameters.

Returns:

Name Type Description
qProp GenericBookmarkProperties Information about the generic object.

Publish

Publishes a bookmark.
This operation is not applicable for Qlik Sense Desktop.

Required permissions: publish

No parameters.

No return values.

SetProperties

Sets some properties for a bookmark.

Required permissions: update

Parameters:

Name Type Mandatory Description
qProp GenericBookmarkProperties Yes Information about the bookmark.

No return values.

UnApprove

Removes the generic bookmark from the list of approved objects
This operation is possible only in Qlik Sense Enterprise.

Required permissions: approve

No parameters.

No return values.

UnPublish

Unpublishes a bookmark.
This operation is not applicable for Qlik Sense Desktop.

Required permissions: publish

No parameters.

No return values.