Get synthetic by selection
This API is extremely reliable and will not be broken unless absolutely necessary.
Method
GET
Path
/qrs/selection/{id}/[type]/synthetic?filter={filter}&privileges={appendPrivileges}
Description
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.
Body
-
Return value
SyntheticEntity:
{ "name": "...", "type": "...", "access": [ "...", "..." ], "children": [ { Another SyntheticEntity }, { ... } ], "properties": [ { "name": "...", "value": { "..." }, "valueisdifferent": Boolean, "valueismodified": Boolean }, { ... } ] }
Optional parameters
-
{filter}: See Filtering.
-
{appendPrivileges}: See Adding privileges.
Example: Get synthetic object from a selection set
This example shows how to get a synthetic object from a selection set.