Get synthetic by selection

LOCKED.

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.

GET https://SELUN-USER.qlik.com:4242/qrs/selection/752ca544-aa8a-4f03-8f13-9e7cf3121abd/engineservice/synthetic?Xrfkey=abcdefghijklmnop HTTP/1.1
Accept-Encoding: gzip,deflate
X-Qlik-User: UserDirectory=INTERNAL; UserId=sa_repository
Accept-Charset: utf-8; q=0.9, us-ascii;q=0.1, iso-8859-1
Accept: text/xml; q=0.1, application/json; q=0.2
X-Qlik-Xrfkey: abcdefghijklmnop
Host: SELUN-USER.qlik.com:4242
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

{ "latestModifiedDate": "2013-10-25T11:59:05.995Z", "name": null, "type": "EngineService", "access": [], "children": [ { "name": "settings", "type": "EngineService.Settings", "access": [], "children": [], "properties": [ { "name": "createdDate", "value": "1753-01-01T00:00:00.000Z", "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "modifiedByUserName", "value": "", "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "modifiedDate", "value": "1753-01-01T00:00:00.000Z", "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sAllowDataLineage", "value": true, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sAuditLogVerbosity", "value": 5, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sAutosaveInterval", "value": 30, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sCpuThrottlePercentage", "value": 0, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sDocumentTimeout", "value": 28800, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sEnableNumaRoundRobin", "value": 0, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sGenericUndoBufferMaxSize", "value": 100, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sGlobalLogMinuteInterval", "value": 5, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sListenerPorts", "value": [4747], "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sOverlayDocuments", "value": true, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sPerformanceLogVerbosity", "value": 5, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sQvLogEnabled", "value": true, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sSessionLogVerbosity", "value": 5, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sSystemLogVerbosity", "value": 5, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sTableFilesDirectory", "value": "", "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sTrafficLogVerbosity", "value": 5, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sWorkingSetSizeHiPct", "value": 90, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sWorkingSetSizeLoPct", "value": 70, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "sWorkingSetSizeMode", "value": 2, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" } ], "schemaPath": "SyntheticEntity" }], "properties": [ { "name": "createdDate", "value": null, "valueIsDifferent": true, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "modifiedByUserName", "value": "INTERNAL\\sa_repository", "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "modifiedDate", "value": null, "valueIsDifferent": true, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "name", "value": null, "valueIsDifferent": true, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "serverNodeConfiguration", "value": { "name": "First", "hostName": "qlik.com", "temporaryfilepath": "", "binaryfileRootpath": "", "privileges": null, "id": "8ddc2896-ff2d-4522-8fd9-86b172e87e0f" }, "valueIsDifferent": true, "valueIsModified": false, "schemaPath": "SyntheticProperty" }, { "name": "refList_Tag", "value": null, "valueIsDifferent": false, "valueIsModified": false, "schemaPath": "SyntheticProperty" } ], "schemaPath": "SyntheticRootEntity" }

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