Skip to main content Skip to complementary content

GetOrCreateObject method

Get or create a generic object at app level with a specific Id and Type. Id and Type are specified in the GenericObjectProperties passed in. All other fields in this parameter serve as default properties. If the object does not exist with that Id, it is created and initialized from the default properties. If the object already exists, it is not changed. The properties passed in are not used. The call will fail if the Id is already used for another purpose, such as for an object of a different Type.

Warning noteEXPERIMENTAL.
This API is under development. Do not rely on it. It may change or be removed in future versions.

Parameters

Name Description Mandatory Type
qProp

GenericObjectProperties with at least Info : { "qId": "<identifier of the new generic object>", "qType": "<type of the new generic object>" }

Yes GenericObjectProperties

Returns

Name Description Type
qNewObject

True if the returned object was created by the request, false if the returned object already existed.

Boolean
qReturn

{ "qType": "GenericObject", "qHandle": <handle of the new object> }

ObjectInterface

Access Control

create

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 – please let us know!