LogoLogo
  • Overview
  • publisher
    • Introduction
    • Getting Started
      • Logging in to Publisher
    • Data Sources
      • Connecting a Data Source
      • Managing a Data Source
      • Connectors
        • AWS S3 Permissions
        • Connecting to AWS S3 Storage
        • Google Cloud Storage (GCS) Permissions
        • Connecting to Google Cloud Storage
        • PostgreSQL Permissions
        • Connecting to PostgreSQL
        • PostgreSQL on Azure Permissions
        • Microsoft Azure Blob Storage Permissions
        • Connecting to Microsoft Azure Blob Storage
        • Connecting to HTTPS
        • Connecting to other sources via Trino
          • BigQuery
    • Collections
      • Creating a Collection
      • Sharing a Collection
      • Collection Filters
      • Editing Collection Metadata
      • Updating Collection Contents
    • Access Policies
      • Creating an Access Policy
      • Managing Access Policies
    • Questions
      • Adding Questions
      • Example Question
    • Settings
      • Viewing Current and Past Administrators
      • Adding an Administrator
      • Removing an Administrator
      • Setting Notification Preferences
  • Explorer
    • Introduction
    • Viewing a Collection
    • Browsing Collections
    • Asking Questions
    • Accessing a Private Collection
      • Requesting Access to a Private Collection
    • Filtering Data in Tables
      • Strings
      • Dates
      • Numbers
  • Workbench
    • Introduction
    • Getting Started
      • Logging into Workbench
      • Connecting an Engine
      • Finding or Importing a Workflow
      • Configuring Workflow Inputs
      • Running and Monitoring a Workflow
      • Locating Outputs
    • Engines
      • Adding and Updating an Engine
        • On AWS HealthOmics
        • On Microsoft Azure
        • On Google Cloud Platform
        • On Premises
      • Parameters
        • AWS HealthOmics
        • Google Cloud Platform
        • Microsoft Azure
        • On-Premises
        • Cromwell
        • Amazon Genomics CLI
    • Workflows
      • Finding Workflows
      • Adding a Workflow
      • Supported Languages
      • Repositories
        • Dockstore
    • Instruments
      • Getting Started with Instruments
      • Connecting a Storage Account
      • Using Sample Data in a Workflow
      • Running Workflows Using Samples
      • Family Based Analysis with Pedigree Information
      • Monitor the Workflow
      • CLI Reference
        • Instruments
        • Storage
        • Samples
        • OpenAPI Specification
    • Entities
    • Terminology
  • Passport
    • Introduction
    • Registering an Email Address for a Google Identity
  • Command Line Interface
    • Installation
    • Usage Examples
    • Working with JSON Data
    • Reference
      • workbench
        • runs submit
        • runs list
        • runs describe
        • runs cancel
        • runs delete
        • runs logs
        • runs tasks list
        • runs events list
        • engines list
        • engines describe
        • engines parameters list
        • engines parameters describe
        • engines health-checks list
        • workflows create
        • workflows list
        • workflows describe
        • workflows update
        • workflows delete
        • workflows versions create
        • workflows versions list
        • workflows versions describe
        • workflows versions files
        • workflows versions update
        • workflows versions delete
        • workflows versions defaults create
        • workflows versions defaults list
        • workflows versions defaults describe
        • workflows versions defaults update
        • workflows versions defaults delete
        • namespaces get-default
        • storage add
        • storage delete
        • storage describe
        • storage list
        • storage update
        • storage platforms add
        • storage platforms delete
        • storage platforms describe
        • storage platforms list
        • samples list
        • samples describe
        • samples files list
      • publisher
        • datasources list
  • Analysis
    • Python Library
    • Popular Environments
      • Cromwell
      • CWL Tool
      • Terra
      • Nextflow
      • DNAnexus
Powered by GitBook

© DNAstack. All rights reserved.

On this page
  • Synopsis
  • List Workflow Defaults
  • Description
  • Examples
  • Flags:
  • --namespace=STRING
  • --workflow=STRING
  • --version=STRING
  • --max-results=NUMBER
  • --page=NUMBER
  • --page-size=NUMBER
  • --sort=SORT_STRING

Was this helpful?

  1. Command Line Interface
  2. Reference
  3. workbench

workflows versions defaults list

List workflow defaults for a given workflow version

Synopsis

List Workflow Defaults

omics workbench workflows versions defaults list
  [--namespace=NAMESPACE]
  [--workflow=WORKFLOW_ID]
  [--version=VERSION_ID]
  [--max-results=NUMBER]
  [--page=NUMBER]
  [--page-size=NUMBER]
  [--sort=SORT_STRING]

Description

List all the workflow defaults for a given workflow version. This command fetches workflow defaults sequentially, printing them to the console.

Examples

List workflow defaults for a given workflow version:

omics workbench workflows versions defaults list --workflow my-workflow-id --version v1

List workflow defaults with pagination:

omics workbench workflows versions defaults list --workflow my-workflow-id --version v1 --page 2 --page-size 5

Flags:

--namespace=STRING

An optional flag to define the namespace to connect to. By default, the namespace is extracted from the user's credentials.

--workflow=STRING

The ID of the workflow for which the defaults will be listed.

--version=STRING

The ID of the workflow version for which the defaults will be listed.

--max-results=NUMBER

Limit the maximum number of results printed to the console.

--page=NUMBER

Used to set the offset page number. This allows for jumping to an arbitrary page of results.

--page-size=NUMBER

Used to set the number of results returned per page (default 100).

--sort=SORT_STRING

Used to sort the workflow defaults by a set of given properties and directions. The SORT_STRING consists of multiple properties to order by, in the form column(:direction)?(;(column(:direction)?)*. The direction of the ordering is optional, and if it is omitted, the default ordering is ascending.

Valid Directions: ASC, DESC

Examples: workflow_id:ASC;version_id:DESC

Previousworkflows versions defaults createNextworkflows versions defaults describe

Last updated 6 months ago

Was this helpful?