Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.onecodex.com/llms.txt

Use this file to discover all available pages before exploring further.

A Job represents a versioned analysis pipeline and is designed to provide strict reproducibility guarantees. In practice, a job encompasses the following strictly versioned components:
  • Reference data
  • Analysis code
  • The execution environment itself (e.g., a Linux container)
All analyses on One Codex are backed by a job that runs on our reproducible analysis infrastructure. The below table summarizes all of the properties for the Job resource, with the JSON schema type of each property listed below in italics.
​
$uri
string
Pattern: ^/api/v1/jobs\/[^/]+$
Example:

"/api/v1/jobs/a1b2c3d4e5f67890"

​
analysis_type
string

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

​
created_at
string<date-time>

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.