CreateChild method

Overview

Creates a generic object that is a child of another generic object.

It is possible to update the properties of the child's parent at the same time that the child is created. Both operations are performed by the same call.

It is possible to create a child that is linked to another generic object. The two objects have the same properties.

Parameters

Name	Description	Type
qProp	Information about the child This parameter is mandatory. It is possible to create a child that is linked to another object.	GenericObjectProperties See GenericObjectProperties
qPropForThis	This parameter is optional. Identifier of the parent's object. Should be set to update the properties of the parent's object at the same time the child is created.	Null or GenericObjectProperties See GenericObjectProperties

Name

Description

Type

qProp

Information about the child

This parameter is mandatory.

It is possible to create a child that is linked to another object.

GenericObjectProperties

See GenericObjectProperties

qPropForThis

This parameter is optional.

Identifier of the parent's object.

Should be set to update the properties of the parent's object at the same time the child is created.

Null or GenericObjectProperties

See GenericObjectProperties

Name	Description	Type
qInfo	Identifier and type of the object. This parameter is mandatory.	NxInfo
qExtendsId	Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). This parameter is mandatory. If you do not want to link your object, set this parameter to an empty string.	String
qMetaDef	Definition of the dynamic properties.	Dynamic properties

Name

Description

Type

qInfo

Identifier and type of the object.

This parameter is mandatory.

NxInfo

qExtendsId

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to).

This parameter is mandatory.

If you do not want to link your object, set this parameter to an empty string.

String

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

In addition to the parameters specified above, the parameter qProp can get any properties defined in the Generic object definition section.

Outputs

The following is returned in the output:

"result": { "qReturn": { "qType": "GenericObject", "qHandle": <handle of the child> }, "qInfo": { "qId": "<identifier of the child>", "qType": "<type of the child>" } }

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