Working with entities

The endpoints described in this section are generic and can be used with different entities. You call these endpoints by specifying the type of entity you want to manipulate.

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'