> ## 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.

# Job Details

Fetch full details for a Job, including its container image, asset dependencies, parent-job dependencies, and the structured arguments schema rendered as field groups suitable for building a UI form. This endpoint is intended for Custom Workflows only.


## OpenAPI

````yaml GET /api/v1/jobs/{id}/details
openapi: 3.1.0
info:
  description: >-
    The One Codex API (v1) -- programmatic access to One Codex's suite of
    microbial genomics data storage, analysis, and query tools.
  title: One Codex API (v1)
  version: v1
servers:
  - url: https://app.onecodex.com
security:
  - apiKeyAuth: []
paths:
  /api/v1/jobs/{id}/details:
    get:
      summary: GET jobs details
      operationId: get_jobs_details
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  arguments_schema:
                    anyOf:
                      - items:
                          properties:
                            description:
                              anyOf:
                                - type: string
                                - type: 'null'
                              default: null
                              title: Description
                            fa_icon:
                              anyOf:
                                - type: string
                                - type: 'null'
                              default: null
                              title: Fa Icon
                            fields:
                              items:
                                properties:
                                  choices:
                                    anyOf:
                                      - items:
                                          anyOf:
                                            - type: string
                                            - type: integer
                                            - type: number
                                            - type: boolean
                                        type: array
                                      - type: 'null'
                                    default: null
                                    title: Choices
                                  default:
                                    anyOf:
                                      - {}
                                      - type: 'null'
                                    default: null
                                    title: Default
                                  description:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                    default: null
                                    title: Description
                                  env_name:
                                    default: ''
                                    title: Env Name
                                    type: string
                                  fa_icon:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                    default: null
                                    title: Fa Icon
                                  help_text:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                    default: null
                                    title: Help Text
                                  name:
                                    title: Name
                                    type: string
                                  pattern:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                    default: null
                                    title: Pattern
                                  required:
                                    default: false
                                    title: Required
                                    type: boolean
                                  type:
                                    anyOf:
                                      - enum:
                                          - string
                                          - regex
                                          - integer
                                          - number
                                          - boolean
                                          - enum
                                          - sample_id
                                          - genome_id
                                          - classified_sample_id
                                          - assembly_id
                                          - ref_assembly_by_tax_id
                                          - genome_tax_id
                                        title: FieldType
                                        type: string
                                      - items:
                                          enum:
                                            - string
                                            - regex
                                            - integer
                                            - number
                                            - boolean
                                            - enum
                                            - sample_id
                                            - genome_id
                                            - classified_sample_id
                                            - assembly_id
                                            - ref_assembly_by_tax_id
                                            - genome_tax_id
                                          title: FieldType
                                          type: string
                                        type: array
                                    title: Type
                                required:
                                  - name
                                  - type
                                title: Field
                                type: object
                              title: Fields
                              type: array
                            title:
                              anyOf:
                                - type: string
                                - type: 'null'
                              default: null
                              title: Title
                          title: FieldGroup
                          type: object
                        type: array
                      - type: 'null'
                    default: null
                    description: >-
                      The schema for the arguments to parametrize this job. Each
                      field is exposed in the script as `$ARGS_<UPPER_NAME>`.
                      Example: `[{"fields": [{"name": "min_quality", "type":
                      "integer"}, {"name": "adapter", "type": "string"}]}]`. The
                      input sample is not a parameter; it is passed separately
                      at run time
                    title: Arguments Schema
                  assets:
                    anyOf:
                      - items:
                          properties:
                            __DOLLAR_REF__:
                              example: /api/v1/assets/a1b2c3d4e5f67890
                              format: uri
                              pattern: ^/api/v1/assets/[a-f0-9]{16}$
                              type: string
                          type: object
                        type: array
                      - type: 'null'
                    default: null
                    description: An optional list of assets associated with this job
                    title: Assets
                  autorun_on_org_sample_upload:
                    description: >-
                      Whether this job runs automatically on every newly
                      uploaded sample in the user's organization.
                    title: Autorun On Org Sample Upload
                    type: boolean
                  cpu:
                    anyOf:
                      - type: number
                      - type: 'null'
                    default: null
                    description: >-
                      The number of CPU cores used for this job, set only for
                      shell script jobs
                    title: Cpu
                  dependencies:
                    anyOf:
                      - items:
                          properties:
                            job:
                              description: Parent job to use as a dependency
                              properties:
                                __DOLLAR_REF__:
                                  example: /api/v1/jobs/a1b2c3d4e5f67890
                                  format: uri
                                  pattern: ^/api/v1/jobs/[a-f0-9]{16}$
                                  type: string
                              type: object
                            output_dir:
                              description: >-
                                Directory into which to download the parent run
                                results (must be relative, will be appended to
                                /out directory)
                              title: Output Dir
                              type: string
                          required:
                            - job
                            - output_dir
                          title: JobDependencySchema
                          type: object
                        type: array
                      - type: 'null'
                    default: null
                    description: >-
                      Optional job dependencies for this job. If provided, will
                      be triggered automatically when this job is run
                    title: Dependencies
                  description:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    description: >-
                      The human-readable description of the job. Supports
                      markdown
                    title: Description
                  image_uri:
                    description: Fully qualified OCI image URI used to run the job.
                    title: Image Uri
                    type: string
                  inject_bearer_token:
                    description: >-
                      Whether the user's One Codex bearer token is injected into
                      the analysis job as $ONE_CODEX_BEARER_TOKEN.
                    title: Inject Bearer Token
                    type: boolean
                  job_type:
                    description: Whether this is a shell script or a Nextflow job.
                    enum:
                      - shell_script
                      - nextflow
                    title: AnalysisJobType
                    type: string
                  ram_gb:
                    anyOf:
                      - type: number
                      - type: 'null'
                    default: null
                    description: >-
                      The amount of RAM used for this job in GB, set only for
                      shell script jobs
                    title: Ram Gb
                  repository:
                    anyOf:
                      - properties:
                          tag:
                            anyOf:
                              - type: string
                              - type: 'null'
                            default: null
                            description: The git tag to use for this repository
                            title: Tag
                          url:
                            description: The URL of the git repository
                            title: Url
                            type: string
                        required:
                          - url
                        title: RepositorySchema
                        type: object
                      - type: 'null'
                    default: null
                    description: The git repository that this job runs against
                  script:
                    description: The script that is executed when the job runs.
                    title: Script
                    type: string
                  storage_gb:
                    anyOf:
                      - type: number
                      - type: 'null'
                    default: null
                    description: >-
                      The amount of storage used for this job in GB, set only
                      for shell script jobs
                    title: Storage Gb
                required:
                  - autorun_on_org_sample_upload
                  - image_uri
                  - inject_bearer_token
                  - job_type
                  - script
                title: JobDetailsSchema
                type: object
          description: OK
components:
  securitySchemes:
    apiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey

````