Skip to main content
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
required
read-only
Pattern: ^/api/v1/jobs/[a-f0-9]{16}$
Example:

"/api/v1/jobs/0d77065796f8d173"

analysis_type
string
required

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

created_at
string<date-time>
required

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

draft
boolean
required

Whether the job is an unpublished draft. Draft jobs are only visible to their creator.

job_args_schema
Job Args Schema · object
required

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

name
string
required

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

public
boolean
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.