run_capsule
Execute Code Ocean capsules or pipelines with specified parameters and data assets to run computational workflows and retrieve results.
Instructions
Execute a capsule or pipeline with specified parameters and data assets.
For capsule execution: Set run_params.capsule_id and optionally provide data_assets, parameters, or named_parameters.
For pipeline execution: Set run_params.pipeline_id and optionally provide data_assets, processes (with process-specific parameters), and nextflow_profile configuration.
Typical workflow: 1) run_capsule() to start execution 2) wait_until_completed() to monitor progress 3) list_computation_results() and get_result_file_urls() to retrieve outputs.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run_params | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| state | Yes | ||
| created | Yes | ||
| run_time | Yes | ||
| exit_code | No | ||
| processes | No | ||
| end_status | No | ||
| parameters | No | ||
| data_assets | No | ||
| has_results | No | ||
| nextflow_profile | No | ||
| cloud_workstation | No |