HTTP API Reference

GET /workflows/{workflow}/aws_schedulers

Retrieve all AWS compute node configuration documents

Retrieve all documents from the “aws_schedulers” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • name (string)

Status Codes:
POST /workflows/{workflow}/aws_schedulers

Store a AWS compute node configuration.

Store a AWS compute node configuration in the “aws_schedulers” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/aws_schedulers

Delete all documents of type AWS compute node configuration for a workflow

Delete all documents from the “aws_schedulers” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/aws_schedulers/{key}

Retrieve the AWS compute node configuration for a key.

Retrieve the document from the “aws_schedulers” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the aws_schedulers document

Status Codes:
PUT /workflows/{workflow}/aws_schedulers/{key}

Update AWS compute node configuration

Update a document in the “aws_schedulers” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the AWS compute node configuration.

Status Codes:
DELETE /workflows/{workflow}/aws_schedulers/{key}

Delete a document of type AWS compute node configuration

Deletes a document from the “aws_schedulers” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the AWS compute node configuration document.

Status Codes:
GET /workflows/{workflow}/compute_nodes

Retrieve all compute node documents

Retrieve all documents from the “compute_nodes” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • hostname (string)

  • is_active (boolean)

Status Codes:
POST /workflows/{workflow}/compute_nodes

Store a compute node.

Store a compute node in the “compute_nodes” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/compute_nodes

Delete all documents of type compute node for a workflow

Delete all documents from the “compute_nodes” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/compute_nodes/{key}

Retrieve the compute node for a key.

Retrieve the document from the “compute_nodes” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the compute_nodes document

Status Codes:
PUT /workflows/{workflow}/compute_nodes/{key}

Update compute node

Update a document in the “compute_nodes” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the compute node.

Status Codes:
DELETE /workflows/{workflow}/compute_nodes/{key}

Delete a document of type compute node

Deletes a document from the “compute_nodes” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the compute node document.

Status Codes:
GET /workflows/{workflow}/compute_node_stats

Retrieve all compute node statistics documents

Retrieve all documents from the “compute_node_stats” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • hostname (string)

Status Codes:
POST /workflows/{workflow}/compute_node_stats

Store a compute node statistics.

Store a compute node statistics in the “compute_node_stats” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/compute_node_stats

Delete all documents of type compute node statistics for a workflow

Delete all documents from the “compute_node_stats” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/compute_node_stats/{key}

Retrieve the compute node statistics for a key.

Retrieve the document from the “compute_node_stats” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the compute_node_stats document

Status Codes:
PUT /workflows/{workflow}/compute_node_stats/{key}

Update compute node statistics

Update a document in the “compute_node_stats” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the compute node statistics.

Status Codes:
DELETE /workflows/{workflow}/compute_node_stats/{key}

Delete a document of type compute node statistics

Deletes a document from the “compute_node_stats” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the compute node statistics document.

Status Codes:
GET /workflows/{workflow}/events

Retrieve all event documents

Retrieve all documents from the “events” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • category (string)

Status Codes:
POST /workflows/{workflow}/events

Store a event.

Store a event in the “events” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/events

Delete all documents of type event for a workflow

Delete all documents from the “events” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/events/{key}

Retrieve the event for a key.

Retrieve the document from the “events” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the events document

Status Codes:
PUT /workflows/{workflow}/events/{key}

Update event

Update a document in the “events” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the event.

Status Codes:
DELETE /workflows/{workflow}/events/{key}

Delete a document of type event

Deletes a document from the “events” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the event document.

Status Codes:
GET /workflows/{workflow}/files

Retrieve all file documents

Retrieve all documents from the “files” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • name (string)

  • path (string)

Status Codes:
POST /workflows/{workflow}/files

Store a file.

Store a file in the “files” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/files

Delete all documents of type file for a workflow

Delete all documents from the “files” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/files/{key}

Retrieve the file for a key.

Retrieve the document from the “files” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the files document

Status Codes:
PUT /workflows/{workflow}/files/{key}

Update file

Update a document in the “files” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the file.

Status Codes:
DELETE /workflows/{workflow}/files/{key}

Delete a document of type file

Deletes a document from the “files” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the file document.

Status Codes:
GET /workflows/{workflow}/jobs

Retrieve all job documents

Retrieve all documents from the “jobs” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • name (string)

  • command (string)

  • status (string)

  • cancel_on_blocking_job_failure (boolean)

  • supports_termination (boolean)

Status Codes:
POST /workflows/{workflow}/jobs

Store a job.

Store a job in the “jobs” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/jobs

Delete all documents of type job for a workflow

Delete all documents from the “jobs” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/jobs/{key}

Retrieve the job for a key.

Retrieve the document from the “jobs” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the jobs document

Status Codes:
PUT /workflows/{workflow}/jobs/{key}

Update job

Update a document in the “jobs” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the job.

Status Codes:
DELETE /workflows/{workflow}/jobs/{key}

Delete a document of type job

Deletes a document from the “jobs” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the job document.

Status Codes:
GET /workflows/{workflow}/job_process_stats

Retrieve all job process statistics documents

Retrieve all documents from the “job_process_stats” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • job_key (string)

  • run_id (integer)

Status Codes:
POST /workflows/{workflow}/job_process_stats

Store a job process statistics.

Store a job process statistics in the “job_process_stats” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/job_process_stats

Delete all documents of type job process statistics for a workflow

Delete all documents from the “job_process_stats” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/job_process_stats/{key}

Retrieve the job process statistics for a key.

Retrieve the document from the “job_process_stats” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the job_process_stats document

Status Codes:
PUT /workflows/{workflow}/job_process_stats/{key}

Update job process statistics

Update a document in the “job_process_stats” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the job process statistics.

Status Codes:
DELETE /workflows/{workflow}/job_process_stats/{key}

Delete a document of type job process statistics

Deletes a document from the “job_process_stats” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the job process statistics document.

Status Codes:
GET /workflows/{workflow}/local_schedulers

Retrieve all local compute node configuration documents

Retrieve all documents from the “local_schedulers” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • memory (string)

  • num_cpus (integer)

Status Codes:
POST /workflows/{workflow}/local_schedulers

Store a local compute node configuration.

Store a local compute node configuration in the “local_schedulers” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/local_schedulers

Delete all documents of type local compute node configuration for a workflow

Delete all documents from the “local_schedulers” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/local_schedulers/{key}

Retrieve the local compute node configuration for a key.

Retrieve the document from the “local_schedulers” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the local_schedulers document

Status Codes:
PUT /workflows/{workflow}/local_schedulers/{key}

Update local compute node configuration

Update a document in the “local_schedulers” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the local compute node configuration.

Status Codes:
DELETE /workflows/{workflow}/local_schedulers/{key}

Delete a document of type local compute node configuration

Deletes a document from the “local_schedulers” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the local compute node configuration document.

Status Codes:
GET /workflows/{workflow}/resource_requirements

Retrieve all resource requirements documents

Retrieve all documents from the “resource_requirements” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • name (string)

  • memory (string)

  • num_cpus (integer)

  • num_gpus (integer)

  • num_nodes (integer)

  • runtime (string)

Status Codes:
POST /workflows/{workflow}/resource_requirements

Store a resource requirements.

Store a resource requirements in the “resource_requirements” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/resource_requirements

Delete all documents of type resource requirements for a workflow

Delete all documents from the “resource_requirements” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/resource_requirements/{key}

Retrieve the resource requirements for a key.

Retrieve the document from the “resource_requirements” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the resource_requirements document

Status Codes:
PUT /workflows/{workflow}/resource_requirements/{key}

Update resource requirements

Update a document in the “resource_requirements” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the resource requirements.

Status Codes:
DELETE /workflows/{workflow}/resource_requirements/{key}

Delete a document of type resource requirements

Deletes a document from the “resource_requirements” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the resource requirements document.

Status Codes:
GET /workflows/{workflow}/results

Retrieve all result documents

Retrieve all documents from the “results” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • job_key (string)

  • run_id (integer)

  • return_code (integer)

  • status (string)

Status Codes:
POST /workflows/{workflow}/results

Store a result.

Store a result in the “results” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/results

Delete all documents of type result for a workflow

Delete all documents from the “results” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/results/{key}

Retrieve the result for a key.

Retrieve the document from the “results” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the results document

Status Codes:
PUT /workflows/{workflow}/results/{key}

Update result

Update a document in the “results” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the result.

Status Codes:
DELETE /workflows/{workflow}/results/{key}

Delete a document of type result

Deletes a document from the “results” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the result document.

Status Codes:
GET /workflows/{workflow}/scheduled_compute_nodes

Retrieve all scheduled compute node documents

Retrieve all documents from the “scheduled_compute_nodes” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • scheduler_id (string)

  • scheduler_config_id (string)

  • status (string)

Status Codes:
POST /workflows/{workflow}/scheduled_compute_nodes

Store a scheduled compute node.

Store a scheduled compute node in the “scheduled_compute_nodes” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/scheduled_compute_nodes

Delete all documents of type scheduled compute node for a workflow

Delete all documents from the “scheduled_compute_nodes” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/scheduled_compute_nodes/{key}

Retrieve the scheduled compute node for a key.

Retrieve the document from the “scheduled_compute_nodes” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the scheduled_compute_nodes document

Status Codes:
PUT /workflows/{workflow}/scheduled_compute_nodes/{key}

Update scheduled compute node

Update a document in the “scheduled_compute_nodes” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the scheduled compute node.

Status Codes:
DELETE /workflows/{workflow}/scheduled_compute_nodes/{key}

Delete a document of type scheduled compute node

Deletes a document from the “scheduled_compute_nodes” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the scheduled compute node document.

Status Codes:
GET /workflows/{workflow}/slurm_schedulers

Retrieve all Slurm compute node configuration documents

Retrieve all documents from the “slurm_schedulers” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • name (string)

  • account (string)

  • gres (string)

  • mem (string)

  • nodes (integer)

  • partition (string)

  • qos (string)

  • tmp (string)

  • walltime (string)

Status Codes:
POST /workflows/{workflow}/slurm_schedulers

Store a Slurm compute node configuration.

Store a Slurm compute node configuration in the “slurm_schedulers” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/slurm_schedulers

Delete all documents of type Slurm compute node configuration for a workflow

Delete all documents from the “slurm_schedulers” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/slurm_schedulers/{key}

Retrieve the Slurm compute node configuration for a key.

Retrieve the document from the “slurm_schedulers” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the slurm_schedulers document

Status Codes:
PUT /workflows/{workflow}/slurm_schedulers/{key}

Update Slurm compute node configuration

Update a document in the “slurm_schedulers” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the Slurm compute node configuration.

Status Codes:
DELETE /workflows/{workflow}/slurm_schedulers/{key}

Delete a document of type Slurm compute node configuration

Deletes a document from the “slurm_schedulers” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the Slurm compute node configuration document.

Status Codes:
GET /workflows/{workflow}/user_data

Retrieve all user data documents

Retrieve all documents from the “user_data” collection for one workflow.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • _key (string)

  • name (string)

  • is_ephemeral (boolean)

Status Codes:
POST /workflows/{workflow}/user_data

Store a user data.

Store a user data in the “user_data” collection.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
DELETE /workflows/{workflow}/user_data

Delete all documents of type user data for a workflow

Delete all documents from the “user_data” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/user_data/{key}

Retrieve the user data for a key.

Retrieve the document from the “user_data” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the user_data document

Status Codes:
PUT /workflows/{workflow}/user_data/{key}

Update user data

Update a document in the “user_data” collection.

Parameters:

  • workflow (string) – Workflow key.

  • key (string) – key of the user data.

Status Codes:
DELETE /workflows/{workflow}/user_data/{key}

Delete a document of type user data

Deletes a document from the “user_data” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – key of the user data document.

Status Codes:
GET /workflows/{workflow}/edges/{name}

Retrieve all edges from the designated collection.

Retrieve all edges from the designated collection.

Parameters:

  • workflow (string) – Workflow key

  • name (string) – Edge collection name

Query Parameters:

  • skip (number)

  • limit (number)

Status Codes:
POST /workflows/{workflow}/edges/{name}

Store an edge between two vertexes.

Store an edge between two vertexes in the designated collection.

Parameters:

  • workflow (string) – Workflow key

  • name (string) – Edge name

Status Codes:
DELETE /workflows/{workflow}/edges/{name}

Delete all edges from the designated collection

Deletes all edges from the designated collection.

Parameters:

  • workflow (string) – Workflow key

  • name (string) – Edge collection name

Status Codes:
GET /workflows/{workflow}/edges/{name}/{key}

Retrieve an edge

Retrieves an edge from the designated collection by key.

Parameters:

  • workflow (string) – Workflow key

  • name (string) – Edge collection name

  • key (string) – Edge key

Status Codes:
DELETE /workflows/{workflow}/edges/{name}/{key}

Delete an edge

Deletes an edge from the designated collection by key.

Parameters:

  • workflow (string) – Workflow key

  • name (string) – Edge name.

  • key (string) – Edge key.

Status Codes:
GET /workflows/{workflow}/files/produced_by_job/{key}

Retrieve files produced by a job

Retrieves files from the “files” collection produced by a job.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Query Parameters:

  • skip (number)

  • limit (number)

Status Codes:
GET /workflows/{workflow}/job_specifications

Retrieve all job definitions

Retrieves all job definitions. Limit output with skip and limit.

Parameters:

  • workflow (string) – Workflow key

Query Parameters:

  • skip (number)

  • limit (number)

Status Codes:
GET /workflows/{workflow}/job_specifications/{key}

Retrieve a job

Retrieves a job from the “jobs” collection by key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Status Codes:
POST /workflows/{workflow}/bulk_jobs

Add jobs in bulk.

Add jobs in bulk. Recommended max job count of 10,000.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/job_keys

Retrieve all job keys for a workflow.

Retrieves all job keys from the “jobs” collection for a workflow.

Parameters:

  • workflow (string) – Workflow key

Status Codes:
GET /workflows/{workflow}/jobs/find_by_status/{status}

Retrieve all jobs with a specific status

Retrieves all jobs from the “jobs” collection with a specific status.

Parameters:

  • workflow (string) – Workflow key

  • status (string) – Job status.

Query Parameters:

  • skip (number)

  • limit (number)

Status Codes:
GET /workflows/{workflow}/jobs/find_by_needs_file/{key}

Retrieve all jobs that need a file

Retrieves all jobs connected to a file by the needs edge.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – File key

Query Parameters:

  • skip (number)

  • limit (number)

Status Codes:
GET /workflows/{workflow}/downstream_jobs/{key}

Retrieve all jobs downstream of another job.

Retrieve all jobs downstream of another job.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Query Parameters:

  • skip (number)

  • limit (number)

Status Codes:
GET /workflows/{workflow}/jobs/{key}/resource_requirements

Retrieve the resource requirements for a job.

Retrieve the resource requirements for a job by its key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Status Codes:
PUT /workflows/{workflow}/jobs/{key}/resource_requirements/{rr_key}

Set the resource requirements for a job.

Set the resource requirements for a job, replacing any current value.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

  • rr_key (string)

Status Codes:
GET /workflows/{workflow}/jobs/{key}/process_stats

Retrieve the job process stats for a job.

Retrieve the job process stats for a job by its key.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Status Codes:
PUT /workflows/{workflow}/jobs/{key}/start_job/{rev}/{run_id}/{compute_node_key}

Start a job.

Start a job and manage side effects.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

  • rev (string) – Current job revision.

  • run_id (integer) – Current job run ID

  • compute_node_key (string) – Compute node key that started the job

Status Codes:
POST /workflows/{workflow}/jobs/{key}/complete_job/{status}/{rev}/{run_id}/{compute_node_key}

Complete a job and add a result.

Complete a job, connect it to a result, and manage side effects.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

  • status (string) – New job status.

  • rev (string) – Current job revision.

  • run_id (integer) – Current job run ID

  • compute_node_key (string) – Compute node key that started the job

Status Codes:
PUT /workflows/{workflow}/jobs/{key}/manage_status_change/{status}/{rev}/{run_id}

Change the status of a job and manage side effects.

Change the status of a job and manage side effects.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

  • status (string) – New job status

  • rev (string) – Current job revision

  • run_id (integer) – Current job run ID

Status Codes:
POST /workflows/{workflow}/jobs/{key}/user_data

Store user data for a job.

Store user data for a job and connect the two vertexes.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Status Codes:
GET /workflows/{workflow}/jobs/{key}/user_data_stores

Retrieve all user data for a job.

Retrieve all user data for a job.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Status Codes:
GET /workflows/{workflow}/jobs/{key}/user_data_consumes

Retrieve all user data consumed by a job.

Retrieve all user data consumed by a job.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Status Codes:
GET /workflows/{workflow}/results/find_by_job/{key}

Retrieve the latest result for a job

Retrieve the latest result for a job. Throws an error if no result is stored.

Parameters:

  • workflow (string) – Workflow key

  • key (string) – Job key

Status Codes:
POST /workflow_specifications

Store a workflow.

Store a workflow.

Status Codes:
GET /workflow_specifications/{key}

Retrieve the current workflow

Retrieves the current workflow in JSON format.

Parameters:

  • key (string) – key of the workflow.

Status Codes:
GET /workflow_specifications/example

Retrieve an example workflow specification

Retrieves an example workflow specification in JSON format.

Status Codes:
GET /workflow_specifications/template

Retrieve the workflow specification template

Retrieve the workflow specification template in JSON format.

Status Codes:
GET /ping

Check if the service is running.

Check if the service is running.

Status Codes:
GET /version

Return the version of the service.

Return the version of the service.

Status Codes:
GET /workflows

Retrieve all workflows

Retrieves all documents from the “workflows” collection.

Query Parameters:

  • skip (number)

  • sort_by (string)

  • reverse_sort (boolean)

  • limit (number)

  • name (string)

  • user (string)

  • description (string)

  • is_archived (boolean)

Status Codes:
POST /workflows

Store a workflow.

Store a workflow in the “workflows” collection.

Status Codes:
GET /workflows/{key}

Retrieve the workflow for an key.

Retrieve the document for a key from the “workflows” collection.

Parameters:

  • key (string) – key of the workflows document

Status Codes:
PUT /workflows/{key}

Update workflow

Update a document in the “workflows” collection.

Parameters:

  • key (string) – Key of the workflow.

Status Codes:
DELETE /workflows/{key}

Delete a workflow

Deletes a document from the “workflows” collection by key.

Parameters:

  • key (string) – Workflow key.

Status Codes:
GET /workflows/{key}/is_complete

Report whether the workflow is complete

Reports true if all jobs in the workflow are complete.

Parameters:

  • key (string) – Workflow key

Status Codes:
GET /workflows/{key}/ready_job_requirements

Return the resource requirements for ready jobs.

Return the resource requirements for jobs with a status of ready.

Parameters:

  • key (string) – Workflow key

Query Parameters:

  • scheduler_config_id (string) – Limit output to jobs assigned this scheduler.

Status Codes:
POST /workflows/{key}/initialize_jobs

Initialize job relationships.

Initialize job relationships based on file and user_data relationships.

Parameters:

  • key (string) – Workflow key

Query Parameters:

  • only_uninitialized (boolean) – Only initialize jobs with a status of uninitialized.

  • clear_ephemeral_user_data (boolean) – Clear all ephemeral user data.

Status Codes:
POST /workflows/{key}/process_changed_job_inputs

Check for changed job inputs and update status accordingly.

Check for changed job inputs and update status accordingly.

Parameters:

  • key (string) – Workflow key

Query Parameters:

  • dry_run (boolean) – If true, report changes but do not change the database.

Status Codes:
GET /workflows/{key}/missing_user_data

List missing user data that should exist.

List missing user data that should exist.

Parameters:

  • key (string) – Workflow key

Status Codes:
GET /workflows/{key}/required_existing_files

List files that must exist.

List files that must exist.

Parameters:

  • key (string) – Workflow key

Status Codes:
POST /workflows/{key}/prepare_jobs_for_submission

Return ready jobs, accounting for resource requirements.

Return jobs that are ready for submission and meet worker resource Sets status to submitted_pending.

Parameters:

  • key (string) – Workflow key

Query Parameters:

  • sort_method (string)

  • limit (number)

Status Codes:
POST /workflows/{key}/prepare_next_jobs_for_submission

Return user-requested number of ready jobs.

Return user-requested number of jobs that are ready for submission. Sets status to submitted_pending.

Parameters:

  • key (string) – Workflow key

Query Parameters:

  • limit (number)

Status Codes:
POST /workflows/{key}/prepare_jobs_for_scheduling

Return scheduler IDs that need to be activated.

Return scheduler IDs that need to be activated. Sets job status to scheduled.

Parameters:

  • key (string) – Workflow key

Status Codes:
POST /workflows/{key}/auto_tune_resource_requirements

Enable workflow for auto-tuning resource requirements.

Enable workflow for auto-tuning resource requirements.

Parameters:

  • key (string) – Workflow key

Status Codes:
POST /workflows/{key}/process_auto_tune_resource_requirements_results

Process the results of auto-tuning resource requirements.

Process the results of auto-tuning resource requirements.

Parameters:

  • key (string) – Workflow key

Status Codes:
GET /workflows/{key}/config

Returns the workflow config.

Returns the workflow config.

Parameters:

  • key (string) – Workflow key

Status Codes:
PUT /workflows/{key}/config

Updates the workflow config.

Updates the workflow config.

Parameters:

  • key (string) – Workflow key

Status Codes:
PUT /workflows/{key}/cancel

Cancel workflow.

Cancel workflow. Workers will detect the status change and cancel jobs.

Parameters:

  • key (string) – Workflow key

Status Codes:
POST /workflows/{key}/reset_status

Reset worklow status.

Reset workflow status.

Parameters:

  • key (string) – Workflow key

Status Codes:
POST /workflows/{key}/reset_job_status

Reset job status.

Reset status for jobs to uninitialized.

Parameters:

  • key (string) – Workflow key

Query Parameters:

  • failed_only (boolean) – Only reset failed jobs

Status Codes:
GET /workflows/{key}/status

Reports the workflow status.

Reports the workflow status.

Parameters:

  • key (string) – Workflow key

Status Codes:
PUT /workflows/{key}/status

Reports the workflow status.

Reports the workflow status.

Parameters:

  • key (string) – Workflow key

Status Codes:
GET /workflows/{key}/collection_names

Retrieve all collection names for one workflow.

Retrieve all collection names for one workflow.

Parameters:

  • key (string) – Workflow key

Status Codes:
POST /workflows/{key}/join_by_inbound_edge/{collection}/{edge}

Retrieve a joined table of two collections.

Retrieve a table of the collections joined by an inbound edge.

Parameters:

  • key (string) – Workflow key

  • collection (string) – From collection

  • edge (string) – Edge name

Query Parameters:

  • collection_key (string)

  • collection_name (string)

  • skip (number)

  • limit (number)

Status Codes:
POST /workflows/{key}/join_by_outbound_edge/{collection}/{edge}

Retrieve a joined table of two collections.

Retrieve a table of the collections joined by an outbound edge.

Parameters:

  • key (string) – Workflow key

  • collection (string) – From collection

  • edge (string) – Edge name

Query Parameters:

  • collection_key (string)

  • collection_name (string)

  • skip (number)

  • limit (number)

Status Codes:
GET /workflows/{key}/latest_event_timestamp

Return the timestamp of the latest event.

Return the timestamp of the latest event in ms since the epoch in UTC.

Parameters:

  • key (string) – Workflow key

Status Codes:
GET /workflows/{key}/events_after_timestamp/{timestamp}

Return all events newer than the event with event_key.

Return all events newer than the event with event_key.

Parameters:

  • key (string) – Workflow key

  • timestamp (number) – Timestamp expressed as number of milliseconds since the epoch in UTC

Query Parameters:

  • category (string)

  • skip (number) – Ignored

  • limit (number)

Status Codes:
GET /workflows/{key}/dot_graph/{name}

Build a string for a DOT graph.

Build a string for a DOT graph.

Parameters:

  • key (string) – Workflow key

  • name (string) – Graph name

Status Codes: