Skip to main content Skip to complementary content

Get synthetic by selection

Information noteLOCKED.

This API is extremely reliable and will not be broken unless absolutely necessary.






Get all entities of a specific [type] from the selection set identified by {id}. Then store the entities in a synthetic object that allows them to be edited simultaneously (so-called multi-edit). Optionally, filter the returned entities and/or add privileges to the returned entities.



Return value


{ "name": "...", "type": "...", "access": [ "...", "..." ], "children": [ { Another SyntheticEntity }, { ... } ], "properties": [ { "name": "...", "value": { "..." }, "valueisdifferent": Boolean, "valueismodified": Boolean }, { ... } ] }

Optional parameters

Example: Get synthetic object from a selection set

This example shows how to get a synthetic object from a selection set.

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!