From 9b63c18ed70faafe6a8e6a3caf898ea008b8de11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Filipe=20Pinto=20Vieira?= Date: Fri, 18 Oct 2024 10:46:07 +0100 Subject: [PATCH 1/4] include a warning message about the response size --- .../integration-with-systems/consume_rest/consume-a-rest-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md b/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md index 6b76ade7..f985dbbf 100644 --- a/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md +++ b/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md @@ -89,7 +89,7 @@ Do the following: ![Headers and authentication tab in REST API consumption dialog in ODC Studio](images/rest-consume-headers-auth-odcs.png "Consume REST API Method - Headers/Auth Tab") -1. Fill the information about the Request and the Response. The easiest way to do this is to perform a test to the API and use the test result. +1. Fill the information about the Request and the Response. The easiest way to do this is to perform a test to the API and use the test result. (Please be aware that handling large responses can lead to slower ODC Studio performance). Alternatively, you can add the JSON structure or plain text example directly in the **Request** and **Response** fields in the **Body** tab. Open the **Test** tab. If you have parameters in your **Method URL**, you need to insert the parameter values to execute the test: From 63270bc01fc2f033429ee3c6e02e05500523b3a1 Mon Sep 17 00:00:00 2001 From: Olivia Michael <144433802+OS-oliviaannemichael@users.noreply.github.com> Date: Tue, 14 Jan 2025 10:36:13 +0100 Subject: [PATCH 2/4] Take out () and rephrasing --- .../integration-with-systems/consume_rest/consume-a-rest-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md b/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md index f985dbbf..ffc24e56 100644 --- a/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md +++ b/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md @@ -89,7 +89,7 @@ Do the following: ![Headers and authentication tab in REST API consumption dialog in ODC Studio](images/rest-consume-headers-auth-odcs.png "Consume REST API Method - Headers/Auth Tab") -1. Fill the information about the Request and the Response. The easiest way to do this is to perform a test to the API and use the test result. (Please be aware that handling large responses can lead to slower ODC Studio performance). +1. Fill the information about the Request and the Response. The easiest way to do this is to perform a test to the API and use the test result. Be aware that handling large responses can lead to slower ODC Studio performance. Alternatively, you can add the JSON structure or plain text example directly in the **Request** and **Response** fields in the **Body** tab. Open the **Test** tab. If you have parameters in your **Method URL**, you need to insert the parameter values to execute the test: From 752b09998dffb1e8c595c5d66afc04f2a1420601 Mon Sep 17 00:00:00 2001 From: Olivia Michael <144433802+OS-oliviaannemichael@users.noreply.github.com> Date: Wed, 15 Jan 2025 09:37:32 +0100 Subject: [PATCH 3/4] Note --- .../consume_rest/consume-a-rest-api.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md b/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md index 35ac3b69..0562b4a6 100644 --- a/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md +++ b/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md @@ -98,7 +98,9 @@ Do the following: ![Headers and authentication tab in REST API consumption dialog in ODC Studio](images/rest-consume-headers-auth-odcs.png "Consume REST API Method - Headers/Auth Tab") -1. Fill the information about the Request and the Response. The easiest way to do this is to perform a test to the API and use the test result. Be aware that handling large responses can lead to slower ODC Studio performance. +1. Fill the information about the Request and the Response. The easiest way to do this is to perform a test to the API and use the test result. + + Note: Handling large responses can lead to slower ODC Studio performance. Alternatively, you can add the JSON structure or plain text example directly in the **Request** and **Response** fields in the **Body** tab. Open the **Test** tab. If you have parameters in your **Method URL**, you need to insert the parameter values to execute the test: From cecdb7e44380251e1555aa36fa59031ada2cc611 Mon Sep 17 00:00:00 2001 From: Olivia Michael <144433802+OS-oliviaannemichael@users.noreply.github.com> Date: Thu, 16 Jan 2025 09:15:09 +0100 Subject: [PATCH 4/4] Bold --- .../consume_rest/consume-a-rest-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md b/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md index 0562b4a6..fd65fc2b 100644 --- a/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md +++ b/src/eap/integration-with-systems/consume_rest/consume-a-rest-api.md @@ -100,9 +100,9 @@ Do the following: 1. Fill the information about the Request and the Response. The easiest way to do this is to perform a test to the API and use the test result. - Note: Handling large responses can lead to slower ODC Studio performance. + **Note:** Handling large responses can lead to slower ODC Studio performance. - Alternatively, you can add the JSON structure or plain text example directly in the **Request** and **Response** fields in the **Body** tab. Open the **Test** tab. If you have parameters in your **Method URL**, you need to insert the parameter values to execute the test: + Alternatively, you can add the JSON structure or plain text example directly in the **Request** and **Response** fields in the **Body** tab. Open the **Test** tab. If you have parameters in your **Method URL**, you need to insert the parameter values to execute the test: ![Test tab in REST API consumption dialog showing method URL and parameters in ODC Studio](images/rest-consume-test-odcs.png "Consume REST API Method - Test Tab")