CreateBookmark method

Overview

Creates a bookmark.

Parameters

Name	Description	Type
qProp	Information about the object. This parameter is mandatory.	GenericBookmarkProperties See GenericBookmarkProperties.

Name

Description

Type

qProp

Information about the object.

This parameter is mandatory.

GenericBookmarkProperties

See GenericBookmarkProperties.

Name	Description	Type
qInfo	Information about the bookmark. This parameter is mandatory.	NxInfo
qMetaDef	Definition of the dynamic properties.	Dynamic properties

Name

Description

Type

qInfo

Information about the bookmark.

This parameter is mandatory.

NxInfo

qMetaDef

Definition of the dynamic properties.

Dynamic properties

Name	Description	Type
qId	Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. This parameter is optional. If an identifier is not set, the engine automatically sets one.	String
qType	Type of the object. This parameter is mandatory.	String

Name

Description

Type

qId

Identifier of the object.

If the chosen identifier is already in use, the engine automatically sets another one.

This parameter is optional. If an identifier is not set, the engine automatically sets one.

String

qType

Type of the object.

This parameter is mandatory.

String

Outputs

The following is returned in the output:

"result": { "qReturn": { "qType": "GenericBookmark", "qHandle": <handle of the bookmark> }, "qInfo": { "qId": "<identifier of the bookmark>", "qType": "Bookmark" } }

Learn more

Create and apply a bookmark

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