Resource Types

This page contains outlines of the resource types available through the pa11y-ws web-service.

Task

A task is a group of settings which will be tested with whenever pa11y-ws generates results. Each task in the application is looped over and results are generated with pa11y.

A task looks like this:

{
    "id": "522f263ccd4cc6fd52000011",
    "name": "Nature Home Page",
    "url": "nature.com",
    "standard": "WCAG2AA",
    "ignore": [],
    "annotations": [
        {"type": "edit", "date": 1385567757583, "comment": "Changed task name"}
    ],
    "last_result": { ... }
}

Note: the last_result property will only be present if it is requested. See documentation in individual endpoints.

Note: the annotations array will only be present if there are annotations on a task, otherwise the property will not be defined.

Result

A result represents the output of one pa11y test on a specific task. It cannot be created manually, as they are created at scheduled intervals.

A result looks like this:

{
    "id": "522f263ccd4cc6fd52000012",
    "task": "522f263ccd4cc6fd52000011",
    "date": "2013-09-16T14:16:19.186Z",
    "count": {
        "error": 2,
        "warning": 4,
        "notice": 6,
        "total": 12
    },
    "results": [ ... ]
}

Note: the results property will only be present if it is requested. See documentation in individual endpoints.