The WES API is a standard way to run and manage portable workflows.
Switch branches/tags
Clone or download

README.md

GA4GH Logo

Workflow Execution Service (WES) API

develop branch status: Build Status Swagger Validator

The Global Alliance for Genomics and Health is an international coalition, formed to enable the sharing of genomic and clinical data.

Cloud Work Stream

The Cloud Work Stream helps the genomics and health communities take full advantage of modern cloud environments. Our initial focus is on “bringing the algorithms to the data”, by creating standards for defining, sharing, and executing portable workflows.

We work with platform development partners and industry leaders to develop standards that will facilitate interoperability.

What is WES?

The Workflow Execution Service API describes a standard programmatic way to run and manage workflows. Having this standard API supported by multiple execution engines will let people run the same workflow using various execution platforms running on various clouds/environments. Key features include:

  • ability to request a workflow run using CWL or WDL
  • ability to parameterize that workflow using a JSON schema
  • ability to get information about running workflows

API Definition

See the human-readable Reference Documentation and the OpenAPI YAML description. You can also explore the specification in the Swagger UI or Swagger Editor.

All documentation and pages hosted at 'ga4gh.github.io/workflow-execution-service' reflect the latest API release from the master branch. To monitor the latest development work, add 'preview/<branch>' to the URLs above (e.g., 'ga4gh.github.io/ga4gh.github.io/workflow-execution-service/preview/<branch>/docs'). To view the latest stable development API specification, refer to the develop branch.

Use Cases

Use cases include:

  • "Bring your code to the data": a researcher who has built their own custom analysis can submit it to run on a dataset owned by an external organization, instead of having to make a copy of the data
  • Best-practices pipelines: a researcher who maintains their own controlled data environment can find useful workflows in a shared directory (e.g., Dockstore.org), and run them over their data

Possible Future Enhancements

  • common JSON parameterization format that works with CWL and WDL
  • validation service for testing WES implementations' conformance to the spec
  • improved tools for troubleshooting execution failures, especially when there are 100s-1000s of tasks
  • a callback mechanism for monitoring status changes in running workflows (e.g., a webhook)
  • integration with GA4GH data access APIs (e.g., htsget, DOS)

How to Contribute Changes

See CONTRIBUTING.md.

If a security issue is identified with the specification, please send an email to security-notification@ga4gh.org detailing your concerns.

License

See the LICENSE.

More Information