Granting queries access to the REST API

For enhanced security, queries that connect to the REST API must be explicitly set to permit access. A query may need to access the REST API if it is being used for an iMIS integration.

To grant API access to a query, the Available via the REST API checkbox must be enabled on each query requiring access; however, the user trying to access the query via the API must still possess the relevant permissions as specified in the query itself.

It is important that Available via the REST API is only enabled for queries that meet at least one of the following criteria:

The query does not contain any personally identifiable information, or
The query is properly filtered to only show information the requesting party is asking for, or
The query is secured so that only staff users have access to it

Enabling the API setting for a query

Do the following to grant API access to an individual query:

Go to RiSE > Intelligent Query Architect.
Locate the query and open it for edit.
Click the Security tab.
Enable Available via the REST API.
Click Save.

Repeat this process for all queries that must be accessed through the REST API.

Determining which queries are available to the REST API

To determine which queries have the Available via the REST API setting enabled, use the QueryDefinition API endpoint with a request to GetRestAccess. Use a list of DocumentVersionKeys or DocumentPaths as the values. The results return either true or false if the REST access is set or not.