QRS API endpoints (subset)

You access the QRS API endpoints to perform create, read, update, and delete operations on entities. The properties within the entities correspond to the properties that are configurable in the QMC.

Note: Not all QRS API endpoints are documented here. For a complete list of all endpoints available in the Qlik Sense Repository Service (QRS) API, see QRS API reference.

Example:  

When communicating directly with the QRS API, the URL is as follows:

https://<QRS machine name>:4242/<path>

Connecting to the QRS API

To call a path, replace <path> with a proper path, such as:

/qrs/[type]/count?filter={filter}

In this example, the Get count path is used.

Get count

In the path, replace [type] with a proper entity type:

/qrs/user/count?filter={filter}

In this example, the user entity type is used.

Optionally, filter the returned entities:

/qrs/user/count?filter=Name eq 'Joe Smith'

In this example, only users named “Joe Smith” are included.

Optional parameters

This means that the URL becomes:

https://<QRS machine name>:4242/qrs/user/count?filter=Name eq 'Joe Smith'

Note: Calls to the QRS API must include Xrfkey headers. See Using Xrfkey headers for information on how to apply the headers.
Tip: Many JSON structs in the Qlik Sense Repository Service (QRS) API include the modifiedDate property, which is used to avoid conflicts in the repository database. For example, when updating an entity, leave the modifiedDate property unchanged. If the modifiedDate property for the updated entity differs from the modifiedDate property for the entity in the QRS, there is a conflict (that is, the entity in the QRS has already been updated by someone else).

Did this information help you?

Can you tell us why it did not help you and how we can improve it?