GET
/
api
/
v1
/
jobs
[
  {
    "$uri": "/api/v1/jobs/a1b2c3d4e5f67890",
    "analysis_type": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "job_args_schema": {},
    "name": "<string>",
    "public": true
  }
]

GET all Jobs instances. Returns a paginated list of Jobs.

Query Parameters

​
page
integer
default:1

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

​
per_page
integer
default:50

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

​
sort
object

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

​
where
object

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

Response

200 - application/json
Successful operation
​
$uri
string
Example:

"/api/v1/jobs/a1b2c3d4e5f67890"

​
analysis_type
string

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

​
created_at
string

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

​
job_args_schema
object

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

​
name
string

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

​
public
boolean

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.