Sign in

v1

latestOpenAPI 3.1.02026-07-267418115.3 KB

GET analyses instances

get/api/v1/analyses

Query parameters

pageinteger

Page number. Defaults to 1. See Pagination for more details.

per_pageinteger

Number of requested paginated records. Defaults to 50. See Pagination for more details.

sortstring nullable

Optional Mongo-style JSON sort clause, e.g., sort={"created_at": true} to sort by created_at (descending)

wherestring nullable

Optional Mongo-style JSON filter clause, e.g., where={"$uri": {"$eq": "/api/v1/samples/0ee172af60e84f61"}}

Response

OK

$uristring required
analysis_type'classification' | 'panel' | 'alignment' | 'control' | 'report' | 'functional' | 'workflow' | 'mlst' | 'assembly_run' required
completeboolean
created_atstring date-time required

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

error_msgstring nullable

The error message from the analysis, if it failed.

job_argsobject

The arguments passed into this analysis (can be null).

successboolean
updated_atstring date-time nullable

Timestamp for when the object was last updated on the One Codex platform, encoded as a RFC 3339 timestamp.

Example response

[
  {
    "$uri": "/api/v1/analyses/0d77065796f8d173",
    "job": {
      "__DOLLAR_REF__": "/api/v1/jobs/a1b2c3d4e5f67890"
    },
    "sample": {
      "__DOLLAR_REF__": "/api/v1/samples/a1b2c3d4e5f67890"
    }
  }
]