Reports

Used to get the available reports of a form.

URL: /api/v1/form/reports/

URL Parameters:

name=[string]: a valid form data model name

Method: GET

Auth required: YES

Permissions required:

Roles: _administrator_, developer, operator, viewer
Permissions: form-<data model name>:edit, form-<data model name>:view

Data constraints: None

Data example: None

Success Response

GET /api/v1/form/reports?name=cores

{
    "single": [
        {
            "name": "Details",
            "title": "Details of record",
            "model": ".*",
            "showInMenu": true,
            "singleRecord": true
        }
    ],
    "multiple": [
        {
            "name": "ListAllCsv",
            "title": "Export full records as CSV file",
            "model": ".*",
            "showInMenu": true,
            "singleRecord": false
        },
        {
            "name": "ListCsv",
            "title": "Export records as CSV file",
            "model": ".*",
            "showInMenu": true,
            "singleRecord": false
        },
        {
            "name": "List",
            "title": "List of records",
            "model": ".*",
            "showInMenu": true,
            "singleRecord": false
        }
    ]
}