Skip to content

CLOUD-18523 Support for dynamic filters in API connector #32

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

Open
cstigum5 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

CLOUD-18523 Support for dynamic filters in API connector #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions snippets/en/Data-Sources/APICreateTable.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,23 @@ Enter the URL of your API endpoint into the **Request URL** field.
</Step>
<Step>
If you select `Post`, supply the **Body** to include in the API request. Then enter the `URL` of your API endpoint.

<p>
You can use the **Body** section to request body filters for `Post` API requests. The following is an example of a request body and a filter:
```
{
"query": { "date_utc": { "$gte": "[_input.startDate]", "$lte": "[_input.endDate]" } }, "options": { "select": \["name", "date_utc", "success", "details"], "sort": { "date_utc": "asc" }, "limit": 20 }
}
```
</p>
In this case, the user is prompted to input a start date and an end date.
<p>
When you have a body filter, **Edit Table** displays the message **Body Filter(s) Detected**.
</p>
<Note>
If your table request body also contains filters, you need to add an escape character to the square bracket, as shown in the example above before `"name"`.
</Note>

</Step>
<Step>
Select a **Response Type** of **JSON**, **LDJSON**, **XML**, or **CSV**.
Expand Down