Update

LOCKED.

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

Method

PUT

Path

/qrs/[type]/{id}

Description

Update an existing entity, identified by {id}, of a specific [type].

Example:

PUT qrs/stream/00000000-0000-0000-0000-000000000001: Update the stream object identified by the specified GUID.

Body

[type]

The body must contain a JSON structure that corresponds to an object of the given [type]. In addition, the GUID in the URL and in the body must correspond to an existing object.

Return value

[type]

The entity is returned, which makes it possible to check the properties that are automatically initialized or updated by the Qlik Sense Repository Service (QRS).

Optional parameters

Example: Update custom property for an engine service

This example shows how to update a custom property for a specific engine service.

PUT https://SELUN-USER.qlik.com:4242/qrs/engineservice/70153267-c74c-47ac-8c7d-9ff7cbdf9b3f?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
Content-Type: application/json;charset=UTF-8
Content-Length: 1598
Host: SELUN-USER.qlik.com:4242
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

{ "customProperties": [{ "Definition":{ "ID": "e1d9edaf-d62e-43c4-9ecc-dc7065ce4e7b"}, "Value": "MAYBE"} }], "name": "MyServerNodeConfiguration Engine", "settings": { "sListenerPorts": [4747], "sOverlayDocuments": true, "sAutosaveInterval": 30, "sDocumentTimeout": 28800, "sTableFilesDirectory": "", "sGenericUndoBufferMaxSize": 100, "sQvLogEnabled": true, "sGlobalLogMinuteInterval": 5, "sSystemLogVerbosity": 5, "sPerformanceLogVerbosity": 5, "sAuditLogVerbosity": 5, "sSessionLogVerbosity": 5, "sTrafficLogVerbosity": 5, "sAllowDataLineage": true, "sWorkingSetSizeLoPct": 70, "sWorkingSetSizeHiPct": 90, "sWorkingSetSizeMode": 2, "sCpuThrottlePercentage": 0, "sEnableNumaRoundRobin": 0, "schemaPath": "EngineService.Settings" }, "serverNodeConfiguration": { "name": "First", "hostName": "qlik.com", "id": "73f2d36c-6f11-486d-81d1-8361ec829bdf" }, "tags": [], "privileges": null, "modifiedDate": "2113-02-04T16:08:28.235Z", "modifiedByUserName": "INTERNAL\\sa_repository", "id": "70153267-c74c-47ac-8c7d-9ff7cbdf9b3f", "schemaPath": "EngineService" }

{ "customProperties": [ { "value": "MAYBE", "definition": { "name": "MyCustomProperty1", "valueType": "Text", "choiceValues": [ "YES", "NO", "MAYBE" ], "privileges": null, "id": "e1d9edaf-d62e-43c4-9ecc-dc7065ce4e7b" }, "id": "a07f0fb9-6a1c-47d1-9b01-03b5860e5eea", "createdDate": "2013-10-29T12:40:25.742Z", "modifiedDate": "2013-10-29T12:40:25.742Z", "modifiedByUserName": "INTERNAL\\sa_repository", "schemaPath": "CustomPropertyValue" }], "name": "MyServerNodeConfiguration Engine", "settings": { "sListenerPorts": [4747], "sOverlayDocuments": true, "sAutosaveInterval": 30, "sDocumentTimeout": 28800, "sTableFilesDirectory": "", "sGenericUndoBufferMaxSize": 100, "sQvLogEnabled": true, "sGlobalLogMinuteInterval": 5, "sSystemLogVerbosity": 5, "sPerformanceLogVerbosity": 5, "sAuditLogVerbosity": 5, "sSessionLogVerbosity": 5, "sTrafficLogVerbosity": 5, "sAllowDataLineage": true, "sWorkingSetSizeLoPct": 70, "sWorkingSetSizeHiPct": 90, "sWorkingSetSizeMode": 2, "sCpuThrottlePercentage": 0, "sEnableNumaRoundRobin": 0, "id": "70153267-c74c-47ac-8c7d-9ff7cbdf9b3f", "createdDate": "1753-01-01T00:00:00.000Z", "modifiedDate": "1753-01-01T00:00:00.000Z", "modifiedByUserName": "", "schemaPath": "EngineService.Settings" }, "serverNodeConfiguration": { "name": "First", "hostName": "qlik.com", "temporaryfilepath": "", "binaryfileRootpath": "", "privileges": null, "id": "73f2d36c-6f11-486d-81d1-8361ec829bdf" }, "tags": [], "privileges": null, "id": "70153267-c74c-47ac-8c7d-9ff7cbdf9b3f", "createdDate": "1753-01-01T00:00:00.000Z", "modifiedDate": "2013-10-29T12:40:25.742Z", "modifiedByUserName": "INTERNAL\\sa_repository", "schemaPath": "EngineService" }

Example: Update tag

This example shows how to update a specific tag.

PUT https://SELUN-USER.qlik.com:4242/qrs/tag/063cffd2-3704-469e-833f-16df78af1a2a?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
Content-Type: application/json
Content-Length: 128
Host: SELUN-USER.qlik.com:4242
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

{
   "Name": "MyTag Updated",
   "ID": "063cffd2-3704-469e-833f-16df78af1a2a",
   "ModifiedDate": "/Date(1382706746631+0200)/"
}

{ "name": "MyTag Updated", "privileges": null, "id": "063cffd2-3704-469e-833f-16df78af1a2a", "createdDate": "1753-01-01T00:00:00.000Z", "modifiedDate": "2013-10-25T13:12:26.656Z", "modifiedByUserName": "INTERNAL\\sa_repository", "schemaPath": "Tag" }

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