Data viewer views are a special kind of view used by the Data viewer reporting tool
Views (settings)
Use this API endpoint to get a list of 'views' for the dataviewer reporting tool. A view is essentially a saved query.
Example request:
| Parameter | Description | Examples |
|---|---|---|
| API | API endpoint | views.json |
| Type | Specify table | type=jobcreate |
| Parameters described in overview | user=user&password=user&version=3.95 | |
| company | The company context | company=1 |
Note: to retrieve views saved by a user, the user name and password would need to be passed
Request for a list of views
http://<SERVER>/jsonapi/views.json?user=user&password=user&type=jobcreate&version=3.95&company=1
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 3,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synversion": "12.960.0060",
"synapiversion": 3.95,
"data": [
{
"settingsUuid": "2CE8942FF47BAC4E92700EAE698FCF71",
"settingsTimestampModified": 1697029953,
"settingsRecordVersionNumber": 0,
"settingsCompany": 1,
"settingsDescription": "Company job create view",
"settingsDisplayOrder": "",
"settingsId": 47107,
"settingsUserid": 0,
"settingsDefault": false,
"settingsSort": "",
"settingsSortDirection": "ASC"
},
{
"settingsUuid": "DD6AAA9EBCA3FA42B3656942DB578A4F",
"settingsTimestampModified": 1697029873,
"settingsRecordVersionNumber": 0,
"settingsCompany": 1,
"settingsDescription": "My job create view",
"settingsDisplayOrder": "",
"settingsId": 47106,
"settingsUserid": 5,
"settingsDefault": false,
"settingsSort": "",
"settingsSortDirection": "ASC"
},
{
"settingsUuid": "A2E6E86C6E14A345B6D38B99E5BC1505",
"settingsTimestampModified": 1697029995,
"settingsRecordVersionNumber": 0,
"settingsCompany": 1,
"settingsDescription": "Group job create view",
"settingsDisplayOrder": "",
"settingsId": 47108,
"settingsUserid": 0,
"settingsDefault": false,
"settingsSort": "",
"settingsSortDirection": "ASC"
}
]
}