Workflows

workflows

Methods

Deletes A Workflow -> Envelope<{ status, success }>
delete/accounts/{account_id}/workflows/{workflow_name}

Deletes a Workflow. This only deletes the Workflow and does not delete or modify any Worker associated to this Workflow or bounded to it.

Get Workflow Details -> Envelope<{ id, class_name, created_on, 5 more... }>
get/accounts/{account_id}/workflows/{workflow_name}

Get Workflow details

List All Workflows -> V4PagePaginationArray<{ id, class_name, created_on, 5 more... }>
get/accounts/{account_id}/workflows

List all Workflows

Create Modify Workflow -> Envelope<{ id, class_name, created_on, 7 more... }>
put/accounts/{account_id}/workflows/{workflow_name}

Create/modify Workflow

Workflows

Instances

workflows.instances

Methods

Batch Create New Workflow Instances -> SinglePage<{ id, status, version_id, 1 more... }>
post/accounts/{account_id}/workflows/{workflow_name}/instances/batch

Batch create new Workflow instances

Create A New Workflow Instance -> Envelope<{ id, status, version_id, 1 more... }>
post/accounts/{account_id}/workflows/{workflow_name}/instances

Create a new workflow instance

Get Logs And Status From Instance -> Envelope<{ end, error, output, 8 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}

Get logs and status from instance

List Of Workflow Instances -> V4PagePaginationArray<{ id, created_on, ended_on, 5 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/instances

List of workflow instances

workflows.instances.events

Methods

Send Event To Instance -> Envelope<unknown>
post/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}

Send event to instance

workflows.instances.status

Methods

Change Status Of Instance -> Envelope<{ status, timestamp }>
patch/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status

Change status of instance

Workflows

Versions

workflows.versions

Methods

Get Workflow Version Details -> Envelope<{ id, class_name, created_on, 2 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}

Get Workflow version details

List Deployed Workflow Versions -> V4PagePaginationArray<{ id, class_name, created_on, 2 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/versions

List deployed Workflow versions