v1

latestOpenAPI 3.1.02026-07-267418115.3 KB

GET jobs details

get/api/v1/jobs/{id}/details

Path parameters

idstring required

Response

autorun_on_org_sample_uploadboolean required

Whether this job runs automatically on every newly uploaded sample in the user's organization.

cpunumber nullable

The number of CPU cores used for this job, set only for shell script jobs

descriptionstring nullable

The human-readable description of the job. Supports markdown

image_uristring required

Fully qualified OCI image URI used to run the job.

inject_bearer_tokenboolean required

Whether the user's One Codex bearer token is injected into the analysis job as $ONE_CODEX_BEARER_TOKEN.

job_type'shell_script' | 'nextflow' required

Whether this is a shell script or a Nextflow job.

ram_gbnumber nullable

The amount of RAM used for this job in GB, set only for shell script jobs

scriptstring required

The script that is executed when the job runs.

storage_gbnumber nullable

The amount of storage used for this job in GB, set only for shell script jobs

Example response

{
  "assets": [
    {
      "__DOLLAR_REF__": "/api/v1/assets/a1b2c3d4e5f67890"
    }
  ],
  "dependencies": [
    {
      "job": {
        "__DOLLAR_REF__": "/api/v1/jobs/a1b2c3d4e5f67890"
      }
    }
  ]
}