In Synergist a 'view' is a saved query. The view ('settings') id is typically passed as a parameter to define which selection of records is returned (see 'models')
Views (settings)
Use this API endpoint to get a list of 'views' for a particular table. A view is essentially a saved query.
Example request:
Parameter | Description | Examples |
|---|---|---|
API | API endpoint | views.json |
Type | Specify table | type=activities |
General | Parameters described in overview | user=user&password=user&version=3.1 |
Company | The company context | company=1 |
Response | Returned data | See below |
Request for a list of views
http://<SERVER>/jsonapi/views.json?user=user&password=user&company=1&type=activities&version=3.1
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 10,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"settings_uuid": "8771237951EB5241A7457443688BA09B",
"settingsTimeStampModified": 1466508984,
"settingsRecordVersionNumber": 0,
"SettingsCompany": 0,
"SettingsDescription": "My open activities",
"SettingsDisplayOrder": "01",
"SettingsSettingsID": -1703,
"SettingsUserID": 0,
"SettingsDefault": false,
"settingsSort": "DATEREQUIRED",
"settingsSortDirection": "ASC"
}
]
}