View Details
Get Views Data. Views can have filters pre-applied to them when created in the UI. Only filters that are marked as supply value later can be modified via the API. These filters and their properties are returned as optionalParameters.
Swagger
Params
| name | Parameter type | Data Type | Values | Description |
|---|---|---|---|---|
| dcviewId | Path | integer | 1 | view Id |
| appliedFilters | Body | object | - | Can be empty if you do not wish to override the filters |
| limit | Query | integer | 20 | limits the number of views returned |
| skip | Query | integer | 20 | set the starting range for the returned values |
Requests
All Data
POST {{host}}/api/rest/v4/data/rows/view/{{viewId}} HTTP/1.1
Authorization: {{auth}}
Content-Type: application/json
[]Filter Column name
Value data structure depends on the type of filter. The required data type should match the optional param.
POST {{host}}/api/rest/v4/data/rows/view/{{viewId}} HTTP/1.1
Authorization: {{auth}}
Content-Type: application/json
[
{
"column": "Watchlist",
"value": [1105]
}
]Filter Column ID
POST {{host}}/api/rest/v4/data/rows/view/{{viewId}} HTTP/1.1
Authorization: {{auth}}
Content-Type: application/json
[
{
"column": 8,
"value": [1105]
}
]Responses
HTTP/1.1 200 OK
{
"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
}
]
}
]
}