General path structure and use

This section describes the general path (that is, endpoint) structure and use in the Qlik Sense Repository Service (QRS) API. The paths described in this section are generic and can be used with different entities.

Example:  

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

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

See: QRS API URLs

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.

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.

See: Optional parameters

This means that the URL becomes:

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