v1

latestOpenAPI 3.1.02026-07-267418115.3 KB

GET jobs instances

get/api/v1/jobs

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

$uristring required

analysis_typestring required

The type of analysis. See the analysis resource for more details.

created_atstring date-time required

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

job_args_schemaobject required

The JSON schema for the arguments taken by the job (can be an empty object, i.e., {}).

namestring required

The name of the job (this is displayed in the dropdown on the analysis page of the One Codex web application).

publicboolean required

Whether the job is publicly available. For most jobs this will be true. Custom, private jobs are also available, and will only be visible to users whose samples (or samples shared with them) have been analyzed using that job.

Example response

[
  {
    "$uri": "/api/v1/jobs/0d77065796f8d173"
  }
]