Legacy API Docs. These docs are for Virtool 4.3.3.

Analyses

Analyses are the results of a given Virtool analytical workflows on a single sample.

Get

Requires read permission on reference

Get a complete analysis document.

GET

/api/analyses/:id

Example

GET /api/analyses/uskrqsxm

Response

Status: 200 OK

{
    "id": "uskrqsxm",
    "ready": true,
    "created_at": "2017-10-03T21:35:54.813000Z",
    "job": {
        "id": "afovbrnx"
    },
    "algorithm": "pathoscope_bowtie",
    "sample": {
        "id": "kigvhuql",
        "name": "Test 1"
    },
    "index": {
        "id": "qldihken",
        "version": 0
    },
    "user": {
        "id": "igboyes"
    },
    "read_count": 23953,
    "diagnosis": [...]

Errors

Status	Message	Reason
400	Parent sample does not exist	the parent sample for the analysis could not be found
403	Insufficient rights	client does not have the required sample rights to view the analysis
404	Not found	`analysis_id` in URL does not exist