How to use the Raw API Request blocks in Qlik Application Automation
This article explains how the Raw API Request blocks in Qlik Application Automation can be used.
Most connectors in Qlik Application Automation have a "Raw API Request" and a "Raw API List Request" block that offer the ability to make an API call to an API resource of your choosing. These blocks will use the connection's account & credentials.
Note: before using these blocks, it's advised to read the API documentation and test the call you want to make in cURL, Postman, or a similar tool.
Below is a detailed overview of these two blocks and how they should be used:
Raw API Request
Path This block will make an API call to the connector's base URL + a path that's specified in the "Path" input parameter. For example, https://hubspot.com/api/v1/ + users. In each implementation of this block, the connector's base URL is hardcoded. Note: do not specify any query parameters in the Path parameter. Use the Query Parameters input field instead.
Method The next parameter is the method that should be used to make the request to the full URL. This can be one of the following methods: GET/POST/PUT/PATCH/DELETE.
Body Parameters The Body Parameters input field allows you to build an object of key-value pairs. This object will be converted to a JSON object and will be sent as a body parameter with the request.
Query Parameters The Query Parameters input field will work similarly to the Body Parameters input field. Except that the final object will be transformed to a query string of the format &key1=value1?key2=value2 and URL encoding will be applied.
See the Raw API Request block of the Qlik Cloud Services connector below as an example:
Raw API List Request
A limitation of the Raw API Request block is that it does not implement pagination. To retrieve a list of records (that exists out of multiple pages), use the block Raw API List Request. This block has built-in paging so no manual paging with the query parameters is required.
This block will work similarly to the Raw API Request block, except for the method, which will be a GET request in all connectors.
See the Raw API List Request block of the Qlik Cloud Services connector below as an example:
The information in this article is provided as-is and to be used at own discretion. Depending on tool(s) used, customization(s), and/or other factors ongoing support on the solution below may not be provided by Qlik Support.