API Reference
DiscoverWorkspaces

Update workflow properties

patch
https://api2.pennsieve.io/compute/workflows/definitions/

Partial update of a workflow definition. Only provided fields are changed.
Allowed when the caller's permissions.canEdit: the creator, an Admin or
Owner of the workflow's workspace, or a super-admin on a public
organization workflow (see workflowPermissions).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The uuid of the workflow

Body Params

Payload

Partial update — only provided fields are changed

string

the name of the workflow

string
length ≤ 100

a short summary of the workflow (max 100 characters)

string

a detailed description of the workflow (supports Markdown)

boolean

whether the workflow is active

defaultParams
object

Update default parameter values for specific DAG nodes, keyed by node ID. Only the specified nodes are updated; other nodes retain their existing defaults.

tags
object

Update the image tag/version pin for specific processor nodes, keyed by node ID. Only the specified nodes are updated; other nodes retain their existing tag. Empty tag values are rejected, and so (400) is a tag whose version doesn't have the step's variant.

positions
object

Where the builder draws steps, inputs and outputs, keyed by their id. Saved in place on the latest version (no new version), since positions never change what runs. Sent on its own, without other fields; an id that isn't a step, input or output is a 400.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?