Get Data Using a View
POST {{host}}/api/rest/v4/data/rows/view/{{viewId}}
Authorization: Bearer {{token}}
Content-Type: application/json
Views can have filters pre-applied to them when created in the UI. Only filters that are marked as "supply value later" allow passing in parameters via the API. These filters and their properties are returned as optionalParameters.
Params
Name | Parameter Type | Data Type | Values | Description |
---|---|---|---|---|
viewId | Path | integer | 1 | view Id |
limit | Query Parameter | integer | 20 | limits the number of rows returned |
skip | Query Parameter | integer | 20 | set the starting range for the returned values |
wrapIntoArrays | Query Parameter | boolean | true | Improves consistency for multi-value fields |
Body | JSON Array of applied filters | Matches data type of column(s) in filter | Body is not required unless overriding filter values |
Additional Requirements
- When using appliedFilters:
- The required data type should match the optional parameter type.
- The body of the request is an array of column-value object pairs.
[ { "column": "string", "value": "string" } ]
Basic Get with no filters
POST {{host}}/api/rest/v4/data/rows/view/MyView
Authorization: Bearer {{token}}
Content-Type: application/json
Response is identical to Get
{
"totalRecords": 1,
"rows": [
{
"EntryId": 1830992,
"Company Name": {
"url": "https://.../portal/pages/5/reports/324/entries/1830992",
"id": 1830992,
"name": "Another Company 2",
"entryListId": 2014
},
"Watchlist": {
"seqNumber": 1,
"isAutoPdf": false,
"id": 1105,
"name": "Yes",
"entryListId": -6
},
"Coverage Person": [
{
"url": "https://.../portal/pages/344/reports/366/entries/1206",
"id": 1206,
"name": "First Last",
"entryListId": -1
},
{
"url": "https://.../portal/pages/344/reports/366/entries/1205",
"id": 1205,
"name": "First Last",
"entryListId": -1
},
{
"url": "https://.../portal/pages/344/reports/366/entries/1441801",
"id": 1441801,
"name": "First Last",
"entryListId": -1
}
]
}
]
}