runs.yaml

  get:
    tags:
    - Workflow Runs
    summary: ListRuns
    description: This list should be provided in a stable ordering. (The actual ordering is implementation dependent.) When paging through the list, the client should not make assumptions about live updates, but should assume the contents of the list reflect the workflow list at the moment that the first page is requested.  To monitor a specific workflow run, use GetRunStatus or GetRunLog.
    operationId: ListRuns
    parameters:
    - name: page_size
      in: query
      description: OPTIONAL The preferred number of workflow runs to return in a page. If not provided, the implementation should use a default page size. The implementation must not return more items than `page_size`, but it may return fewer.  Clients should not assume that if fewer than `page_size` items are returned that all items have been returned.  The availability of additional pages is indicated by the value of `next_page_token` in the response.
      style: form
      explode: true
      schema:
        type: integer
        format: int64
    - name: page_token
      in: query
      description: OPTIONAL Token to use to indicate where to start getting results. If unspecified, return the first page of results.
      style: form
      explode: true
      schema:
        type: string
    responses:
      200:
        description: ''
        headers: {}
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunListResponse'
      400:
        description: The request is malformed.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResponse'
      401:
        description: The request is unauthorized.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResponse'
      403:
        description: The requester is not authorized to perform this action.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResponse'
      500:
        description: An unexpected error occurred.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResponse'
    deprecated: false
  post:
    tags:
    - Workflow Runs
    summary: RunWorkflow
    description: >-
      This endpoint creates a new workflow run and returns a `RunId` to monitor its progress.

      The `workflow_attachment` array may be used to upload files that are required to execute the workflow, including the primary workflow, tools imported by the workflow, other files referenced by the workflow, or files which are part of the input.  The implementation should stage these files to a temporary directory and execute the workflow from there. These parts must have a Content-Disposition header with a "filename" provided for each part.  Filenames may include subdirectories, but must not include references to parent directories with '..' -- implementations should guard against maliciously constructed filenames.

      The `workflow_url` is either an absolute URL to a workflow file that is accessible by the WES endpoint, or a relative URL corresponding to one of the files attached using `workflow_attachment`.

      The `workflow_params` JSON object specifies input parameters, such as input files.  The exact format of the JSON object depends on the conventions of the workflow language being used.  Input files should either be absolute URLs, or relative URLs corresponding to files uploaded using `workflow_attachment`.  The WES endpoint must understand and be able to access URLs supplied in the input.  This is implementation specific.

      The `workflow_type` is the type of workflow language and must be "CWL" or "WDL" currently (or another alternative  supported by this WES instance).

      The `workflow_type_version` is the version of the workflow language submitted and must be one supported by this WES instance.

      See the `RunRequest` documentation for details about other fields.
    operationId: RunWorkflow
    parameters: []
    requestBody:
      content:
        multipart/form-data:
          encoding: {}
          schema:
            type: object
            properties:
              workflow_params:
                type: string
              workflow_type:
                type: string
              workflow_type_version:
                type: string
              tags:
                type: string
              workflow_engine_parameters:
                type: string
              workflow_url:
                type: string
              workflow_attachment:
                type: array
                items:
                  type: string
                  format: binary
                description: ''
      required: false
    responses:
      200:
        description: ''
        headers: {}
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunId'
      400:
        description: The request is malformed.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResponse'
      401:
        description: The request is unauthorized.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResponse'
      403:
        description: The requester is not authorized to perform this action.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResponse'
      500:
        description: An unexpected error occurred.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResponse'
    deprecated: false