ONonecodex

GET analyses

Changed on
get/api/v1/analyses/{id}

Request

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

Path parameters

idstring required

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
    • 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