From b158177bda4840319fb53aee7794a12853b68390 Mon Sep 17 00:00:00 2001 From: Jonathan Roques Date: Wed, 11 Dec 2024 16:29:15 +0100 Subject: [PATCH 1/2] docs(rest-connector): Add documentation for the Document upload in the REST Connector --- docs/components/connectors/protocol/rest.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/components/connectors/protocol/rest.md b/docs/components/connectors/protocol/rest.md index 1cdeca28c1..9d387a5d8b 100644 --- a/docs/components/connectors/protocol/rest.md +++ b/docs/components/connectors/protocol/rest.md @@ -213,6 +213,10 @@ Secrets are currently not supported in the body of a **REST Connector**. ## Response +:::note +Starting from version 8.7.0, the REST Connector supports storing the response as a document. +::: + The HTTP response will be available in a temporary local `response` variable. This variable can be mapped to the process by specifying the **Result variable**. The following fields are available in the `response` variable: @@ -220,6 +224,15 @@ The following fields are available in the `response` variable: - **status**: Response status - **body**: Response body of your request - **headers**: Response headers +- **document**: When the `Store response` checkbox is selected, this field will represent the stored document: + - **documentId**: The ID of the stored document + - **storeId**: The store ID + - **metadata**: Metadata of the stored document (if available) + - **size**: Size of the stored document in bytes + - **expiresAt**: Expiration date of the stored document + - **fileName**: Name of the stored document + - **customProperties**: Custom properties of the stored document + - **contentType**: Content type of the stored document ## Output mapping @@ -237,7 +250,8 @@ Additionally, you can choose to unpack the content of your `response` into multi = { actual_temp: response.body.main.temp, feel_temp: response.body.main.feels_like, - weather: response.body.weather[1].main + weather: response.body.weather[1].main, + weather_report_id: response.document.documentId } ``` From 1f911eb57d01dfebcfa913a173ddcad224003b43 Mon Sep 17 00:00:00 2001 From: mesellings Date: Thu, 12 Dec 2024 12:31:27 +0000 Subject: [PATCH 2/2] TW edits --- docs/components/connectors/protocol/rest.md | 24 ++++++++++----------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/components/connectors/protocol/rest.md b/docs/components/connectors/protocol/rest.md index 9d387a5d8b..386ef8e954 100644 --- a/docs/components/connectors/protocol/rest.md +++ b/docs/components/connectors/protocol/rest.md @@ -221,18 +221,18 @@ The HTTP response will be available in a temporary local `response` variable. Th The following fields are available in the `response` variable: -- **status**: Response status -- **body**: Response body of your request -- **headers**: Response headers -- **document**: When the `Store response` checkbox is selected, this field will represent the stored document: - - **documentId**: The ID of the stored document - - **storeId**: The store ID - - **metadata**: Metadata of the stored document (if available) - - **size**: Size of the stored document in bytes - - **expiresAt**: Expiration date of the stored document - - **fileName**: Name of the stored document - - **customProperties**: Custom properties of the stored document - - **contentType**: Content type of the stored document +- **status**: Response status. +- **body**: Response body of your request. +- **headers**: Response headers. +- **document**: If the `Store response` checkbox is selected, this field represents the stored document: + - **documentId**: The ID of the stored document. + - **storeId**: The store ID. + - **metadata**: Metadata of the stored document (if available). + - **size**: Size of the stored document (in bytes). + - **expiresAt**: Expiration date of the stored document. + - **fileName**: Name of the stored document. + - **customProperties**: Custom properties of the stored document. + - **contentType**: Content type of the stored document. ## Output mapping