How to read data with the ArcQL filter using the REST API

We have seen retrieving the data using the REST API in the previous post. Now, we will use the ArcQL filter to select and read only the required data.

Again, data can be retrieved using the GET method. Here is a sample endpoint to read the data.

  • https://api.staging.hypi.dev/rest/v1/StudentMedicalRecord?arcql=height=5.5

The endpoint rest/v1/ is appended with the data type and arcql statement. Here, our data type is StudentMedicalRecord and arcql=height=5.5 is the arcql statement. Replace these two values with your own set of values. For String values in the arcql statement, please use single quotes.

Here is the sample cURL request.

Sample

curl --location --request GET 'https://api.staging.hypi.dev/rest/v1/StudentMedicalRecord?arcql=height=5.5' \
--header 'hypi-domain: inclemency.apps.hypi.app' \
--header 'content-type: application/json' \
--header 'authorization: Auth_Key'

***Replace url, hypi-domain, authorization with your own set of values.

Check the Read Data with GET (ArcQL filter) - 2 POSTMAN collection for the data retrieval request in different programming languages! Click </> and choose the programming language of your choice.
Run in Postman