Skip to content

Start Workflow Run

codecatalyst_start_workflow_run R Documentation

Begins a run of a specified workflow

Description

Begins a run of a specified workflow.

Usage

codecatalyst_start_workflow_run(spaceName, projectName, workflowId,
  clientToken)

Arguments

spaceName

[required] The name of the space.

projectName

[required] The name of the project in the space.

workflowId

[required] The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use list_workflows.

clientToken

A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

Value

A list with the following syntax: 

list(
  spaceName = "string",
  projectName = "string",
  id = "string",
  workflowId = "string"
)

Request syntax

svc$start_workflow_run(
  spaceName = "string",
  projectName = "string",
  workflowId = "string",
  clientToken = "string"
)