Sign in

v1

latestOpenAPI 3.1.02026-07-267418115.3 KB

GET alignments

get/api/v1/alignments/{id}

Path parameters

idstring required

Response

OK

$uristring 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/alignments/0d77065796f8d173",
  "job": {
    "__DOLLAR_REF__": "/api/v1/jobs/a1b2c3d4e5f67890"
  },
  "sample": {
    "__DOLLAR_REF__": "/api/v1/samples/a1b2c3d4e5f67890"
  }
}