widgetic api workflows

19 commands for the Workflows operations of the REST API, generated from its OpenAPI description.

widgetic api workflows <command> runs the Workflows operations of the REST API. It has 19 commands. Every command also takes the flags every command takes.

​

widgetic api workflows archive-workspace-workflow

Archive a Workflow

• Request: POST /workspaces/{workspaceId}/workflows/{workflowId}/archive
• Operation: archiveWorkspaceWorkflow (widgetic api call archiveWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows archive-workspace-workflow.

​

widgetic api workflows create-workspace-workflow

Create a Workflow

• Request: POST /workspaces/{workspaceId}/workflows
• Operation: createWorkspaceWorkflow (widgetic api call createWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--idempotency-key <text>	text		Names this one request, so a repeat of it is carried out once. The CLI makes a key when this is left out and sends the same one on every try; give your own (a UUID is ideal) to repeat the call by hand later.
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--name <text>	text
--composition-id <uuid>	uuid		A composition of this workspace to start with.
--timezone <text>	text		An IANA time zone name; UTC when not given.
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api workflows create-workspace-workflow.

​

widgetic api workflows create-workspace-workflow-from-preset

Start a Workflow from a starting point

• Request: POST /workspaces/{workspaceId}/workflows/from-preset
• Operation: createWorkspaceWorkflowFromPreset (widgetic api call createWorkspaceWorkflowFromPreset runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--idempotency-key <text>	text		Names this one request, so a repeat of it is carried out once. The CLI makes a key when this is left out and sends the same one on every try; give your own (a UUID is ideal) to repeat the call by hand later.
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--key <text>	text		The starting point, as listWorkspaceWorkflowPresets gives it.
--name <text>	text		The new workflow’s name. The starting point’s title when left out.
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api workflows create-workspace-workflow-from-preset.

​

widgetic api workflows delete-workspace-workflow

Delete a Workflow

• Request: DELETE /workspaces/{workspaceId}/workflows/{workflowId}
• Operation: deleteWorkspaceWorkflow (widgetic api call deleteWorkspaceWorkflow runs it by that name)
• Works with any API key.
• It deletes something, so it asks first; without a terminal it needs --yes.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows delete-workspace-workflow.

​

widgetic api workflows discard-workspace-workflow-changes

Discard the Unpublished Changes of a Workflow

• Request: POST /workspaces/{workspaceId}/workflows/{workflowId}/discard
• Operation: discardWorkspaceWorkflowChanges (widgetic api call discardWorkspaceWorkflowChanges runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--revision <int>	integer
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api workflows discard-workspace-workflow-changes.

​

widgetic api workflows duplicate-workspace-workflow

Duplicate a Workflow

• Request: POST /workspaces/{workspaceId}/workflows/{workflowId}/duplicate
• Operation: duplicateWorkspaceWorkflow (widgetic api call duplicateWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--idempotency-key <text>	text		Names this one request, so a repeat of it is carried out once. The CLI makes a key when this is left out and sends the same one on every try; give your own (a UUID is ideal) to repeat the call by hand later.
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows duplicate-workspace-workflow.

​

widgetic api workflows get-workspace-workflow

Get a Workflow

• Request: GET /workspaces/{workspaceId}/workflows/{workflowId}
• Operation: getWorkspaceWorkflow (widgetic api call getWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows get-workspace-workflow.

​

widgetic api workflows get-workspace-workflow-stats

Get what Visitors Did in a Workflow

• Request: GET /workspaces/{workspaceId}/workflows/{workflowId}/stats
• Operation: getWorkspaceWorkflowStats (widgetic api call getWorkspaceWorkflowStats runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--version-id <uuid>	uuid		Count one version only
--from <text>	text		First UTC day (YYYY-MM-DD)
--to <text>	text		Last UTC day (YYYY-MM-DD)
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows get-workspace-workflow-stats.

​

widgetic api workflows get-workspace-workflow-version

Get a Published Version of a Workflow

• Request: GET /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}
• Operation: getWorkspaceWorkflowVersion (widgetic api call getWorkspaceWorkflowVersion runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--version-id <uuid>	uuid	yes	The id of a published version of the workflow
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows get-workspace-workflow-version.

​

widgetic api workflows list-workspace-workflow-composition-options

List the compositions a workflow can show, and what each can do

• Request: GET /workspaces/{workspaceId}/workflows/composition-options
• Operation: listWorkspaceWorkflowCompositionOptions (widgetic api call listWorkspaceWorkflowCompositionOptions runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--search <text>	text		Text the composition’s name must contain
--ids <text>	text		Only these compositions (comma-separated ids, at most 50), those of them you may see. Ask for the compositions a workflow shows with this, so each is found whatever page it would be on.
--limit <int>	integer		Page size (1-100, 50 when not given)
--offset <int>	integer		How many to skip (0 when not given)
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows list-workspace-workflow-composition-options.

​

widgetic api workflows list-workspace-workflow-presets

List the starting points for a new Workflow

• Request: GET /workspaces/{workspaceId}/workflows/presets
• Operation: listWorkspaceWorkflowPresets (widgetic api call listWorkspaceWorkflowPresets runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows list-workspace-workflow-presets.

​

widgetic api workflows list-workspace-workflow-versions

List the Published Versions of a Workflow

• Request: GET /workspaces/{workspaceId}/workflows/{workflowId}/versions
• Operation: listWorkspaceWorkflowVersions (widgetic api call listWorkspaceWorkflowVersions runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows list-workspace-workflow-versions.

​

widgetic api workflows list-workspace-workflows

List the Workflows of a Workspace

• Request: GET /workspaces/{workspaceId}/workflows
• Operation: listWorkspaceWorkflows (widgetic api call listWorkspaceWorkflows runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--search <text>	text		Text the workflow’s name must contain
--status <text>	one of draft, live, paused, archived, all		One state to list (draft, live, paused, archived), or all for every state. Without it, the ones in use (draft, live and paused).
--sort <text>	text		<field>:<asc|desc> where field is createdAt, lastPublishedAt, runsCount or name (or just asc / desc for createdAt). Newest first when not given.
--limit <int>	integer		Page size (1-100, 50 when not given)
--offset <int>	integer		How many to skip (0 when not given)
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows list-workspace-workflows.

​

widgetic api workflows pause-workspace-workflow

Pause a Workflow

• Request: POST /workspaces/{workspaceId}/workflows/{workflowId}/pause
• Operation: pauseWorkspaceWorkflow (widgetic api call pauseWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows pause-workspace-workflow.

​

widgetic api workflows publish-workspace-workflow

Publish the Draft of a Workflow

• Request: POST /workspaces/{workspaceId}/workflows/{workflowId}/publish
• Operation: publishWorkspaceWorkflow (widgetic api call publishWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--idempotency-key <text>	text		Names this one request, so a repeat of it is carried out once. The CLI makes a key when this is left out and sends the same one on every try; give your own (a UUID is ideal) to repeat the call by hand later.
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--revision <int>	integer
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api workflows publish-workspace-workflow.

​

widgetic api workflows restore-workspace-workflow-version

Restore a Version of a Workflow into the Draft

• Request: POST /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore
• Operation: restoreWorkspaceWorkflowVersion (widgetic api call restoreWorkspaceWorkflowVersion runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--version-id <uuid>	uuid	yes	The id of a published version of the workflow
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--revision <int>	integer
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api workflows restore-workspace-workflow-version.

​

widgetic api workflows resume-workspace-workflow

Resume a Paused Workflow

• Request: POST /workspaces/{workspaceId}/workflows/{workflowId}/resume
• Operation: resumeWorkspaceWorkflow (widgetic api call resumeWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows resume-workspace-workflow.

​

widgetic api workflows save-workspace-workflow

Save the Draft of a Workflow

• Request: PUT /workspaces/{workspaceId}/workflows/{workflowId}
• Operation: saveWorkspaceWorkflow (widgetic api call saveWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--revision <int>	integer		The revision the editor read.
--name <text>	text
--timezone <text>	text
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api workflows save-workspace-workflow.

​

widgetic api workflows unarchive-workspace-workflow

Unarchive a Workflow

• Request: POST /workspaces/{workspaceId}/workflows/{workflowId}/unarchive
• Operation: unarchiveWorkspaceWorkflow (widgetic api call unarchiveWorkspaceWorkflow runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--workspace-id <text>	text	yes	The workspace: ‘personal’ for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses ‘personal’: a managed user has no other workspace, and a call…
--workflow-id <uuid>	uuid	yes	The workflow’s id
--managed-user-id <uuid>	uuid		The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.
--managed-user-external-id <text>	text		Your own id for the managed user (its externalId), when you do not keep Widgetic’s. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer’s work.

The whole description and the schemas: widgetic schema api workflows unarchive-workspace-workflow.