From d4b5dbcae42c496fa4b0cddc5bc108a26964fde0 Mon Sep 17 00:00:00 2001 From: quinntracy Date: Thu, 5 Jun 2025 16:03:41 +0200 Subject: [PATCH 1/8] Add original query parameters content --- .../consumed-rest-services/_index.md | 2 +- .../consumed-rest-service.md | 25 +++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) 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..4d6bec3b461 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,31 @@ 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 by adding them manually in the Query parameters grid. + +To append query params to the end of a URL, a question mark (?) is added followed immediately by a query parameter. To add multiple parameters, an ampersand (&) is added in between each, joining them to form a query string parameter. These can be created by any variation of object types or lengths such as strings, arrays, and numbers. The following is an example: + +{{< figure src="/attachments/refguide/modeling/integration/consumed-rest-service/query-paramters.png" >}} + +You can also manually add new query parameters to the Query parameters grid directly. To do so, follow these steps: + +1. Open the Parameters tab and click Add query parameter. +2. Name your query parameter and add a test value. + +In this case, the newly configured query parameter will be automatically added in the URL. + +By default when a new query parameter is added to the grid, it is configured as a Required query parameter. You can still change the query param to not required by clicking the dropdown and the change the value of the Required property to "No". + +If you would like to include or exclude a query parameter from the URL, you can simply check/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: From adaf31aeb42b68dc4e2e88c74e906633f1c06a11 Mon Sep 17 00:00:00 2001 From: quinntracy Date: Fri, 6 Jun 2025 10:30:21 +0200 Subject: [PATCH 2/8] Revise --- .../consumed-rest-service.md | 23 ++++++++++++------- 1 file changed, 15 insertions(+), 8 deletions(-) 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 4d6bec3b461..3a29dcd1f1e 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 @@ -158,22 +158,29 @@ 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 by adding them manually in the Query parameters grid. +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. -To append query params to the end of a URL, a question mark (?) is added followed immediately by a query parameter. To add multiple parameters, an ampersand (&) is added in between each, joining them to form a query string parameter. These can be created by any variation of object types or lengths such as strings, arrays, and numbers. The following is an example: +##### 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-paramters.png" >}} -You can also manually add new query parameters to the Query parameters grid directly. To do so, follow these steps: +##### 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 and click Add query parameter. -2. Name your query parameter and add a test value. +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 in the URL. +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 still change the query param to not required by clicking the dropdown and the change the value of the Required property to "No". +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**. -If you would like to include or exclude a query parameter from the URL, you can simply check/uncheck the checkbox of the specific query parameter. +To include or exclude a query parameter from the URL, check or uncheck the checkbox of the specific query parameter. ### Adding Headers {#add-headers} From f661a9de34687206934192ba349696e0520b8c22 Mon Sep 17 00:00:00 2001 From: quinntracy Date: Fri, 6 Jun 2025 10:34:01 +0200 Subject: [PATCH 3/8] Add screenshot --- .../consumed-rest-service/query-parameters.png | Bin 0 -> 161530 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 static/attachments/refguide/modeling/integration/consumed-rest-service/query-parameters.png 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 0000000000000000000000000000000000000000..1c86ebfa808689d198535540e40f4e6b49e16421 GIT binary patch literal 161530 zcmeFZWl&!2vNnhZcMTpqI0OyBouI+p3GVJ1T!OnLxVyW%ySuyVJjC9-`NPce79dX16WNuMNYLAOI{-VMlKFB(} zQl*(e&_!zeB^mhyfw+jJS_uwVc!FyX#9C!!v;kLmo-ZFRitoT2CV0#2 zr#?PUR`|TB1p*?5UVE3W8V+;H19U>_DI4<&NE+JlJl9c%L>;a)6cz%~G8)++$08Cr zJNG1-Gqnbjrb7~lApiWf3>N5J9pP{vhAuZQ`v5wth>tc@ha2Mk#+C#+F9(J;_73Rw zH_FRdL#`d&2XRJIsmS4B%#J+OyI>rG7%}Uc@#kTy2lM_xY1jcRxJ0KcDq_KS#)A3C zgI+Ds0{GKcBFg;49dkfwHHtIa#T^451%w;=@GFseYD@GzpiVIzC8&y1!;sEE+X$F_ zSk=CwAT1q#ilc#-xof#g*IVOI$LVlFR0!DcEPdo8(~Z=D*lLWYS+}~o-F8vZfE9f- z4?J)P6~!MPLOs2^r0@0`sNwg|MSQgpgz|=9%7c|R1s8kjI8r9OHw5z}fb$oB)%$^F`wTFu2bP-Jf0Ld5tO zoZ&%IsE9dzxMV@Zr=@T4rX#m*yK}nM?8cIE+}sy5qEHGp1_?qVx4Yqk2Zz0bK79|v z5IN6SleJviRC*X8m*comM})5-04nhSsd`6;r3-9ntl)~#Aae-@%o*+pO8^4@IMCwX z(S!%Z(d7klLdO4w03T<2d72XBHvF00N6u=EN5a+yX!p@oG}`0@bxjo!!fK^5LsEnR zlLy2B1nZRR&00ID2irzV*1_}j1JHf)DmQ6EDnKng83+!@paH-gh}wvw=qxR+7PK5V zc#oRaU9&aa+<426P?AulK0-d&K6Y)%B5S;};pE+3b~*SH8mSfd``#)%;tC7+*M56a zSO#klEx`7k=N1+ktmTxtwU3sR`E9Q=9;;#9YWN=AP|2W0u>?;uXJB!2wX#>)b217p z!!D&e6POjvk2HrzZfm(@H6Vwz_&$^h%m5$Y*df<@Flk+S_~LfIE8w;FP zD?2MYaPHej>Bglc{%cnSME!nyv!`Pq2mIs1!w+Z4FdyJsIPGslSs#+iwb~_vUIT3- zz@V17pnai40K3^rYtNR%#{{+31UB z;8_aJ_#+_u`w-C!BYzFlB|zr)9N^y~BIyzRhBNCWOLQOJ-XpRBGUm6ygZC!6$9MxJ zFnuov-pEHeok*IwkEeZv)dnQNQ-TL(1bj!P0=AIfKHYXlwSEI}<1PQgk;ZsKP6-b7r8ToIeg5C=&15urs)Mc74zMizZ#7sl@~(nTp_ zWb;q@7!wZD`+XyMLuVs@!(d|=RXmWSGZI+@Nha%4jC7UsYl>J3+^At$>O7{&#MeTD z8AF*d(#E+4IoCPn6B82y6C4v6lO0CZlYJ9cdC3aSIaktZDvJ`y`6(GiQW|+pe2+eN zxR)&NUJnLt35jKGj>e4T8D@V*_>BJ!^L6NJ4!HC#oDk>`_K^J7w7aNvB*}cK!nA3z zV+bR(U46xFxzn*GuVB#XRu#9 zQas&k?twjn#gF}wY38#J!YnNaP)F~SAJR