View

Get Views. 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
query	Query	string	report	string search against view name
isPrivate	Query	boolean	true	Returns only private view
limit	Query	integer	20	limits the number of views returned
skip	Query	integer	20	set the starting range for the returned values

Requests

All Views

GET {{host}}/api/rest/v4/data/rows/view HTTP/1.1

Query

GET {{host}}/api/rest/v4/data/rows/view?query=Companies HTTP/1.1

Private

GET {{host}}/api/rest/v4/data/rows/view?query=Companies&isprivate=true HTTP/1.1

Responses

HTTP/1.1 200 OK
 
{
  "totalRecords": 11,
  "rows": [
    {
      "id": 1,
      "name": "Companies - All Targets",
      "primaryLists": [
        {
          "id": 2014,
          "name": "Company",
          "entryListId": 0
        }
      ],
      "optionalParameters": [
        {
          "columnId": 8,
          "columnName": "Watchlist?",
          "defaultValue": [
            1105
          ]
        }
      ]
    },
    {
      "id": 2,
      "name": "Companies - Non Target",
      "primaryLists": [
        {
          "id": 2014,
          "name": "Company",
          "entryListId": 0
        }
      ],
      "optionalParameters": []
    },
    {
      "id": 3,
      "name": "Investors",
      "primaryLists": [
        {
          "id": 2014,
          "name": "Company",
          "entryListId": 0
        }
      ],
      "optionalParameters": []
    },
  ...
  ]
}

Put View Details