POST /api/database/views/grid/{view_id}/
Lists only the rows and fields that match the request. Only the rows with the ids that are in the row_ids list are going to be returned. Same goes for the fields, only the fields with the ids in the field_ids are going to be returned. This endpoint could be used to refresh data after changes something. For example in the web frontend after changing a field type, the data of the related cells will be refreshed using this endpoint. In the example all field types are listed, but normally the number in field_{id} key is going to be the id of the field. The value is what the user has provided and the format of it depends on the fields type.
Servers
- /
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
view_id |
Integer | Yes |
Returns only rows that belong to the related view's table. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
row_ids[] |
Array | Yes |
Only rows related to the provided ids are added to the response. |
field_ids[] |
Array | No |
Only the fields related to the provided ids are added to the response. If None are provided all fields will be returned. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.