ONonecodex

GET analyses instances

Changed on
get/api/v1/analyses

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/analyses
  • Auth
    API key in header X-API-Key

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_typestring 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"
    }
  }
]

Changes

  • 3be5a5f9bf7dRevision changes
    • breaking

      for the query request parameter per_page, default value was changed from 50 to 20

    • info

      removed the alignment enum value from the / response property for the response status

    • info

      removed the assembly_run enum value from the / response property for the response status

    • info

      removed the classification enum value from the / response property for the response status

    • info

      removed the control enum value from the / response property for the response status

    • info

      removed the functional enum value from the / response property for the response status

    • info

      removed the mlst enum value from the / response property for the response status

    • info

      removed the panel enum value from the / response property for the response status

    • info

      removed the report enum value from the / response property for the response status

    • info

      removed the workflow enum value from the / response property for the response status