Add

LOCKED.

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

Method

POST

Path

/qrs/[type]

Description

Add a new entity of a specific [type]. Optionally, include an empty GUID in the API call.

Example:

POST qrs/stream: Add a new stream object.

To create an app through an API call, use the engine API (see Create an app), which reuses the /qrs/app endpoint. It is the engine that creates the app's metadata, so if you attempt to create an app by calling the qrs/app API endpoint directly, you will get an entry in the database but no physical file.

Body

[type]

The body must contain a JSON structure that corresponds to an object of the given [type].

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). For example, if no GUID is given in the body, the QRS automatically assigns a GUID to the new entity.

Optional parameters

{appendPrivileges}: See Adding privileges.

Example: Add custom property to engine services

This example shows how to create a custom property and add it to the engine service entity type.

POST https://SELUN-USER.qlik.com:4242/qrs/custompropertydefinition?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: 209
Host: SELUN-USER.qlik.com:4242
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

{
   "name": "MyCustomProperty",
   "valueType": "Text",
   "choiceValues":    [
      "YES",
      "NO",
      "MAYBE"
   ],
   "objectTypes": ["EngineService"],
   "schemaPath": "CustomPropertyDefinition"
}

{ "name": "MyCustomProperty", "valueType": "Text", "choiceValues": [ "YES", "NO", "MAYBE" ], "objectTypes": ["EngineService"], "privileges": null, "id": "4f06fd34-df99-4146-896b-cae1060551d5", "createdDate": "2013-10-25T12:09:42.071Z", "modifiedDate": "2013-10-25T12:09:42.071Z", "modifiedByUserName": "INTERNAL\\sa_repository", "schemaPath": "CustomPropertyDefinition" }

Example: Add tag

This example shows how to add a tag.

POST https://SELUN-USER.qlik.com:4242/qrs/tag?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: 171
Host: SELUN-USER.qlik.com:4242
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

{ "id": "00000000-0000-0000-0000-000000000000", "modifiedByUserName": "", "name": "MyTag", "schemaPath": "Tag", "modifiedDate": "0001-01-01T00:00:00" }

{ "name": "MyTag", "privileges": null, "id": "b45f4fda-994c-40db-a0f6-9f741b25892e", "createdDate": "2013-10-25T13:14:13.363Z", "modifiedDate": "2013-10-25T13:14:13.363Z", "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