List variables

Lists a paginated resultset of all active dataset's variables

{success} This is a public route

Method Uri Auth Permissions
GET /v1/variables none none

Headers

The API requires a header Accept to be submitted with the request:

{
    "Accept": "application/json"
}

Query Params

In case of using different pagination counts than the default (15), add limit to the url parameters.

GET /v1/variables?limit=100&page=4

Success Responses

Condition : All required data provided is valid and added to the request body.

Code : 200 Okay

Content example : Response will reflect back the entities:

{
    "data": [
        {
            "id": "5b62895d-9ad9-4005-9d8d-c639ab3d72e2",
            "name": "@#WMH",
            "label": "Number of WMH"
        },
        ...
    ],
    "links": {
        "first": "http:\/\/dms.test\/v1\/variables?page=1",
        "last": "http:\/\/dms.test\/v1\/variables?page=465",
        "prev": null,
        "next": "http:\/\/dms.test\/v1\/variables?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 465,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http:\/\/dms.test\/v1\/variables?page=1",
                "label": 1,
                "active": true
            },
            ...
        ],
        "path": "http:\/\/dms.test\/v1\/variables",
        "per_page": 15,
        "to": 15,
        "total": 6962
    }
}