Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(rest-connector): Add documentation for the Document upload in the REST Connector #4751

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+18 −4
Open

docs(rest-connector): Add documentation for the Document upload in the REST Connector #4751

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b158177
docs(rest-connector): Add documentation for the Document upload in th…
johnBgood Dec 11, 2024
1f911eb
TW edits
mesellings Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions docs/components/connectors/protocol/rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,13 +213,26 @@ 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:

- **status**: Response status
- **body**: Response body of your request
- **headers**: Response headers
- **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

Expand All @@ -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
}
```

Expand Down
Loading