diff --git a/content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/_index.md b/content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/_index.md index d370bdb8f93..49e96574ddb 100644 --- a/content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/_index.md +++ b/content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/_index.md @@ -12,7 +12,7 @@ Mendix offers different features which allow you to interact with any REST API. ## Read More -* [Consumed REST Services](/refguide/consumed-rest-service/), an overview on how to Consume a REST Service document +* [Consumed REST Service](/refguide/consumed-rest-service/), an overview on how to Consume a REST Service document * [Import an OpenAPI/Swagger contract](/refguide/consumed-rest-service/#installation), instructions on how to create a Consumed REST Service from an OpenAPI/Swagger contract * [Call REST Service](/refguide/call-rest-action/), a description of the microflow action * [Use Call REST Service Action in a Microflow](/refguide/integration/use-call-rest-action-in-microflow/), instructions on how to use the Call REST Service action in a microflow diff --git a/content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/consumed-rest-service.md b/content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/consumed-rest-service.md index 77d68b1dfcf..589d1f267c3 100644 --- a/content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/consumed-rest-service.md +++ b/content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/consumed-rest-service.md @@ -150,6 +150,38 @@ You can add a Base URL as a parameter. To do this, follow these steps: Your base URL is now considered as a parameter. You can change its value in the [Send REST Request](/refguide/send-rest-request/) microflow activity. +#### Adding Query Parameters + +{{% alert color="info" %}} + +Query parameters are available for Studio Pro 11.0.0 GA and above. + +{{% /alert %}} + +Query parameters can be configured in the **Parameters** tab in the **Query Parameters** field. You can define them directly in the URL or add them manually in the Query parameters field. + +##### Add Query Parameter to URL + +To add query parameters to the end of a URL, add a question mark (?), followed immediately by the query parameter. + +To add multiple parameters, add an ampersand (&) between each parameter, joining them to form a query string parameter. These can be created by any variation of object types or lengths such as strings, arrays, or numbers. + +{{< figure src="/attachments/refguide/modeling/integration/consumed-rest-service/query-parameters.png" >}} + +##### Manually Add Query Parameters + +You can manually add new query parameters directly to the Query parameters grid. To do this, follow the steps below: + +1. Open the **Parameters** tab. +2. Click **Add query parameter**. +3. Name your query parameter and add a test value. + +In this case, the newly configured query parameter will be automatically added to the URL. + +By default, when a new query parameter is added to the grid, it is configured as a **Required** query parameter. You can change this setting to **Not required** by clicking the drop-down and changing the value of the required property to **No**. + +To include or exclude a query parameter from the URL, check or uncheck the checkbox of the specific query parameter. + ### Adding Headers {#add-headers} You can add a header for any HTTP request you have specified in your document. To add a header, do the following: diff --git a/static/attachments/refguide/modeling/integration/consumed-rest-service/query-parameters.png b/static/attachments/refguide/modeling/integration/consumed-rest-service/query-parameters.png new file mode 100644 index 00000000000..1c86ebfa808 Binary files /dev/null and b/static/attachments/refguide/modeling/integration/consumed-rest-service/query-parameters.png differ