API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Workflow

3 minute readReference

completeWorkflow

Marks a workflow as completed. When completed, transitions are no longer evaluated.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowName

String

(Required) The name of the workflow.

Positional arguments

projectName, workflowName

Usage

ec-perl

$cmdr->completeWorkflow(<projectName>, <workflowName>);
▼

ectool

ectool completeWorkflow projectName,  workflowName
▼

deleteWorkflow

Deletes a workflow, including all states and transitions.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowName

String

(Required) The name of the workflow.

deleteProcesses

Boolean

True to delete processes associated with the workflow.

Positional arguments

projectName, workflowName

Usage

ec-perl

$cmdr->deleteWorkflow(<projectName>, <workflowName>, {<optionals>});
▼

ectool

ectool deleteWorkflow projectName,  workflowName, [optionals]
▼

getState

Finds a state by its name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowName

String

(Required) The name of the workflow.

stateName

String

(Required) The name used for the new state.

Positional arguments

projectName, workflowName, stateName

Usage

ec-perl

$cmdr->getState(<projectName>, <workflowName>, <stateName>);
▼

ectool

ectool getState projectName,  workflowName,  stateName
▼

getStates

Retrieves all states in a workflow.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowName

String

(Required) The name of the workflow.

Positional arguments

projectName, workflowName

Usage

ec-perl

$cmdr->getStates(<projectName>, <workflowName>);
▼

ectool

ectool getStates projectName,  workflowName
▼

getTransition

Finds a transition by its name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowName

String

(Required) The name of the workflow.

stateName

String

(Required) The name used for the new state.

transitionName

String

(Required) The name used for the transition instance.

Positional arguments

projectName, workflowName, stateName, transitionName

Usage

ec-perl

$cmdr->getTransition(<projectName>, <workflowName>, <stateName>, <transitionName>);
▼

ectool

ectool getTransition projectName,  workflowName,  stateName,  transitionName
▼

getTransitions

Retrieves all transitions in a workflow.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowName

String

(Required) The name of the workflow.

stateName

String

(Required) The name used for the new state.

targetState

String

Limits results to transitions that have the specified state as a target.

Positional arguments

projectName, workflowName, stateName

Usage

ec-perl

$cmdr->getTransitions(<projectName>, <workflowName>, <stateName>, {<optionals>});
▼

ectool

ectool getTransitions projectName,  workflowName,  stateName, [optionals]
▼

getWorkflow

Finds a workflow by its name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowName

String

(Required) The name of the workflow.

Positional arguments

projectName, workflowName

Usage

ec-perl

$cmdr->getWorkflow(<projectName>, <workflowName>);
▼

ectool

ectool getWorkflow projectName,  workflowName
▼

getWorkflows

Retrieves all workflow instances in a project.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getWorkflows(<projectName>);
▼

ectool

ectool getWorkflows projectName
▼

runWorkflow

Runs the specified workflow definition and returns the workflow name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowDefinitionName

String

(Required) The name of the workflow definition.

actualParameters

Map

The list of actual parameters.

credentials

Collection

Credentials to be used in the state.

priority

JobPriority

The priority of jobs launched by the workflow.

scheduleName

String

Name for the schedule; must be unique among all schedules for the project.

startingState

String

The name of the starting state.

Positional arguments

projectName, workflowDefinitionName

Usage

ec-perl

$cmdr->runWorkflow(<projectName>, <workflowDefinitionName>, {<optionals>});
▼

ectool

ectool runWorkflow projectName,  workflowDefinitionName, [optionals]
▼

transitionWorkflow

Manually transitions from the active workflow state.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

workflowName

String

(Required) The name of the workflow.

stateName

String

(Required) The name used for the new state.

transitionName

String

(Required) The name used for the transition instance.

actualParameters

Map

The list of actual parameters.

credentials

Collection

Credentials to be used in the state.

Positional arguments

projectName, workflowName, stateName, transitionName

Usage

ec-perl

$cmdr->transitionWorkflow(<projectName>, <workflowName>, <stateName>, <transitionName>, {<optionals>});
▼

ectool

ectool transitionWorkflow projectName,  workflowName,  stateName,  transitionName, [optionals]
▼
Widget filter override
Workflow definition