Get Workflow

codecatalyst_get_workflow

R Documentation

Returns information about a workflow

Description

Returns information about a workflow.

Usage

codecatalyst_get_workflow(spaceName, id, projectName)

Arguments

spaceName

[required] The name of the space.

id

[required] The ID of the workflow. To rerieve a list of workflow IDs, use list_workflows.

projectName

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

Value

A list with the following syntax:

list(
  spaceName = "string",
  projectName = "string",
  id = "string",
  name = "string",
  sourceRepositoryName = "string",
  sourceBranchName = "string",
  definition = list(
    path = "string"
  ),
  createdTime = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedTime = as.POSIXct(
    "2015-01-01"
  ),
  runMode = "QUEUED"|"PARALLEL"|"SUPERSEDED",
  status = "INVALID"|"ACTIVE"
)

Request syntax

svc$get_workflow(
  spaceName = "string",
  id = "string",
  projectName = "string"
)