API Response and Element Glossary

The first part of this topic lists some (but not all) of the response container elements in alphabetical order. The contents for each container element lists all or most of the possible response elements—both simple and subcontainer elements. Depending on your request, you might not see all elements in your response. If the value of an element is "empty," that element is typically omitted from the response.

Elements annotated with a * (asterisk) may appear multiple times in a response.

The second part of this Help topic is an element glossary for some (but not all) of the single or "leaf" elements and subcontainer elements. Click here to go to the glossary or notice that each response element is a link—each response element is linked directly to its glossary entry.

aclEntry

Contains an ACE (access control list entry) on an object for a given principal.

Contents:

aclEntryId

changePermissionsPrivilege

executePrivilege

modifyPrivilege

readPrivilege

principalName

principalType

actualParameter

An actualParameter object provides the value for a parameter, which is passed to a procedure when it is invoked. Actual parameters can be provided for jobs and nested subprocedures within a job. Actual parameters are different from "formal parameters"- formal parameters define the parameters a procedure is expecting, and actual parameters provide values to use at run-time.

Contents:

actualParameterId

actualParameterName

createTime

modifyTime

value

archiveConnector

In order to support different kinds of archival systems, the data archiving framework provides an extension mechanism that can be used by enterprises to register archive connectors to store the data to be archived into their archival system.

archiveConnectorName

Type: String

formalParameters

Type: String

systemGenerated

Type: String

archiveScript

Type: String

retrivalScript

Type: String

artifact

Contains elements to define the artifact. An artifact is specified by groupId and artifactKey. The name of an artifact is in this form "groupId:artifactKey". An artifact contains a collection of artifactVersions.

Contents:

artifactId

artifactKey

artifactName

artifactVersionNameTemplate

createTime

description

groupId

lastModifiedBy

modifyTime

owner

propertySheetId

credential

Contains a stored credential. The password is returned for the getFullCredential API only.

Contents:

credentialId

credentialName

createTime

description

lastModifiedBy

modifyTime

owner

password

projectName

propertySheetId

userName

databaseConfiguration

Contain configuration information about communicating with the database used to store server data.

Contents:

batchRequests

batchSize

completeUserName

customDatabaseDialect

customDatabaseDriver

customDatabaseUrl

databaseDialect

databaseDriver

databaseName

databaseType

databaseUrl

hostName

port

statementCacheSize

userName

dataRetentionPolicy

acl

Type: ACL

action

[ archiveOnly, purgeAfterArchive, purgeOnly ]

Type: Enum

age

Type: Number

ageUnit

[ days, weeks, months, years ]

Type: Enum

canonicalPath

Type: String

createTime

Type: Date

dataRetentionPolicyId

Type: UUID

dataRetentionPolicyName

Type: String

deleted

Type: Number

description

Type: String

includeSubreleases

Type: Boolean

lastModifiedBy

Type: String

modifyTime

Type: Date

objectType

[ deployment, job, pipelineRun, release ]

Type: Enum

owner

Type: String

propertySheet

dashboard

acl

Acl

canonicalPath

string

createTime

date

dashboardName

uuid

dashboardName

string

description

string

lastModifiedBy

string

layout

modifyTime

date

owner

string

projectName

string

propertySheet

reportingFilterCount

number

tracked

type

widgetCount

number

devOpsInsightDataSource

acl

Type: ACL

canonicalPath

Type: String

connectionInfo

Type: String

createTime

Type: Date

description

Type: String

devOpsInsightDataSourceId

Type: UUID

devOpsInsightDataSourceName

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

pluginKey

Type: String

propertySheet

PropertySheet

releaseName

Type: String

releaseProjectName

Type: String

reportObjectType

Type: String

scheduleName

Type: String

scheduleProjectName

Type: String

sourceDetails

Type: String

tracked

Type: Boolean

emailConfig

Contains information about the configuration used to communicate with an email server.

Contents:

configName

createTime

description

emailConfigId

emailConfigName

lastModifiedBy

mailFrom

mailHost

mailPort

mailProtocol

mailUser

modifyTime

owner

propertySheetId

emailNotifier

Contains information about an email notifier.

Contents:

condition

configName

container

createTime

description

destinations

emailNotifierId

eventType

formattingTemplate

lastModifiedBy

modifyTime

notifierName

owner

propertySheetId

environment

applicationCount

Type: Number

clusterCount

Type: Number

createTime

Type: Date

deploymentTime

Type: Date

environmentEnabled

Type: Boolean

environmentId

Type: UUID

environmentName

Type: String

failedCount

Type: Number

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

projectName

Type: String

propertySheetId

Type:UUID

resourceCount

Type: Number

serviceCount

Type: Number

tierCount

Type: Number

tracked

Type: Boolean

utilityResourceCount

Type: Number

environmentApplication

applicationId

Type: UUID

applicationName

Type: String

applicationProjectName

Type:String

artifactCount

Type: Number

deployedEntityId

Type: UUID

deployedEntityName

Type: String

deployedEntityProjectsName

Type: String

deployedEntityType

Type: String

environmentName

Type: String

failedCount

Type: Number

environmentDeployment

artifactCount

Type: Number

deployedEntityId

Type: UUID

deployedEntityName

Type: String

deployedEntityProcessName

Type: String

deployedEntityType

Type: String

failedCount

Type: Number

environmentInventory

applicationId

Type: UUID

applicationName

Type: String

applicationProcessId

Type: UUID

artifactName

Type: String

clusterName

Type: String

completionTime

Type: Time

containerName

Type: String

count

Type: Number

deployedEntityId

Type: UUID

deployedEntityName

Type: String

deployedEntityProcessName

Type: String

deployedEntityType

Type: String

environmentName

Type: String

failedCount

Type: Number

headDeployedEntityId

Type: UUID

jobId

Type: UUID

serviceName

Type: String

warnCount

Type: Number

environmentInventoryItem

applicationName

Type: String

applicationProcessId

Type: UUID

artifactName

Type: String

clusterId

Type: UUID

clusterName

Type: String

complianceStatus

Type: String

containerName

Type: String

createTime

Type: Date

deploymentTime

Type: Ddate

environmentName

Type: String

jobStepId

Type: UUID

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

projectName

Type: String

propertySheetId

Type:UUID

serviceName

Type: String

status

Type: String

versionMismatch

Type: Number

environmentMap

environmentMapId

Type: UUID

environmentMapName

Type: String

createTime

Type: Date

environmentName

Type: String

environmentProjectName

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

projectName

Type: String

serviceName

Type: String

tracked

Type: Boolean

validMapping

Type: Boolean

flowRuntime

General object parameters

A `flowRuntime ` object includes general parameters, below, as well as several Boolean flags .

abortedBy

Type: String

abortStatus

[ ABORT, FORCE_ABORT ]

Type: String

acl

Type: Acl

actionLabelText

Type: String

actualParameters

canonicalPath

Type: String

createTime

Type: Date

credentialName

Type: String

currentRunNumber

Type: Number

deleted

Type: Number

elapsedTime

Type: Number

finish

Type: Date

flowId

Type: UUID

flowName

Type: UUID

flowRuntimeId

Type: UUID

flowRuntimeName

Type: String

gateId

Type: UUID

gateType

[ POST, PRE ]

Type: String

lastModifiedBy

Type: String

launchedByUser

Type: String

liveSchedule

Type: String

modifyTime

Type: Date

outcome

[ success, warning, error, skipped ]

Type: String

outputParameters

PropertySheet

owner

Type: String

pipelineId

Type: UUID

pipelineName

Type: String

prerunTaskStatus

Set if there are prerun tasks in the stage. Possible values are: [ running, error, warning, success ]

progressPercentage

Type: Number

projectName

Type: String

propertySheet

PropertySheet

propertySheetId

Type: UUID

releaseId

Type: UUID

releaseName

Type: String

restartCount

Type: Number

runAsUser

Type: String

stageCount

Type: String

stageId

Type: UUID

stageName

Type: String

stagesToRun

Type: String

start

Type: Date

startingStage

Type: String

subErrorHandling

[ continueOnError, stopOnError ]

Type: String

taskId

Type: UUID

taskName

Type: String

waitingManualRetryCount

Type: Number

Boolean flags

aborted

1—The pipeline run is aborted.

allowCurrentUserToApprove

1—The logged in user is allowed to approve a waiting task in a stage or gate.

alwaysRun

1—The pipeline run has a task that is configured as an `alwaysRun ` task.

alwaysRunStatesOnly

1—The pipeline run is marked to run all `alwaysRun ` tasks before it’s completed.

completed

1—The pipeline run is complete.

dummyRuntime

1—Set for either of these conditions:

  • A pipeline run is created as a placeholder to represent a failed run from a schedule.

  • A sub-pipeline invocation fails a pipeline task.

hasManualApproval

1—Set for either of these conditions:

  • The pipeline run is waiting on a manual stage task.

  • The pipeline run is waiting on a gate task.

hasParallelStages

1—The pipeline run has parallel stages.

prerun

1—The task has been been executed out of order.

prerunAllowed

1—The task is allowed to be run out of order.

restartable

1—The pipeline run has at least one stage or task that can be restarted.

scheduleFired

1—The pipeline run is triggered from a schedule.

waitingForDependency

1—The pipeline run has one or more stage/gate/task waiting for dependency.

waitingForManualRetry

1—The pipeline run is waiting on one or more manual retry tasks.

waitingForPrecondition

1—The pipeline run has a stage or gate waiting for a pre-condition.

allowCurrentUserToApprove

1—The logged in user is allowed to approve a waiting task in a stage or gate.

completed

1—The release run is complete.

waitingForApproval

1—The pipeline run is waiting on a manual stage or gate task.

waitingForManualRetry

1—The pipeline run is waiting on one or more manual retry tasks.

waitingOnManual

1—The pipeline run is waiting on a manual stage task.

formalParameter

Contains information about a formal parameter.

Contents:

canonicalPath

Type: String

container

Type: String

containerType

Type: String

createTime

Type: Date

defaultValue

Type: String

dependsOn

Type: String, max length is 255 chars

description

Type: String

expansionDeferred

Type: Boolean

formalParameterId

Type: UUID

formalParameterName

Type: String

label

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

optionsDsl

Type: String, max length is 4000 chars

optionsType

[ dsl, options, propertyReference, propertySheetOptions, simpleList ]

Type: String

orderIndex

Type: Number

owner

Type: String

propertyReference

Type: String, max length is 255 chars

propertyReferenceType

[ property, propertySheet ]

Type: String

renderCondition

Type: String, max length is 255 chars

renderConditionDependsOn

Type: String, max length is 255 chars

required

Type: Boolean

revisionId

Type: UUID

tracked

Type: Boolean

type

Type: String

validationDsl

Type: String, max length is 4000 chars.

gateway

Contains information about a gateway.

Contents:

createTime

description

gatewayDisabled

gatewayId

gatewayName

hostName1

hostName2

lastModifiedBy

modifyTime

owner

port1

port2

propertySheetId

resourceName1

resourceName2

group

Contains information about a defined group of users.

acl

Type: ACL

canonicalPath

Type: String

createTime

Type: Date

email

Type: String

groupId

Type: UUID

groupName

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

mutable

If True, the member list of this group is editable within CloudBees Flow via the web UI or the modifyGroup API.

Type: Boolean

owner

Type: String

propertySheet

providerName

Type: String

jobStep

Contains information to define or locate a job step.

abortStatus

Type: String

abortedBy

Type: String

acl

Type: ACL

actionLabelText

Type: String

actualParameters

afterLastRetry

Type: String

allowSkip

Type: Boolean

alwaysRun

Type: Boolean

assignedResourceName

Type: String

broadcast

Type: Boolean

canonicalPath

Type: String

combinedStatus

Type: String

command

Type: String

comment

Type: String

condition

Type: String

conditionExpanded

Type: Boolean

createTime

Type: Date

delayUntil

Type: Date

disableFailure

Type: Boolean

duration

Type: String

elapsedTime

Type: Number

errorCode

Type: String

errorHandling

Type: String

errorMessage

Type: String

exclusive

Type: Boolean

exclusiveMode

Type: String

exitCode

Type: Number

external

Type: Boolean

finish

Type: Date

hostName

Type: String

instruction

Type: String

job

Type: job

jobId

Type: UUID

jobStepId

Type: UUID

lastModifiedBy

Type: String

licenseReshareWaitTime

Type: Number

licenseWaitTime

Type: Number

liveProcedure

Type: String

liveProcedureStep

Type: String

liveProcess

Type: String

liveProcessStep

Type: String

liveProcessStepId

Type: UUID

liveProcessStepRevisionId

Type: UUID

liveProcessStepType

Type: String

logFileName

Type: String

manualStepApprover

Type: String

modifyTime

Type: Date

outcome

Type: String

outcomeReasonCode

Type: String

outputParameters

owner

Type: String

parallel

Type: Boolean

parent

Type: jobStep

postExitCode

Type: Number

postLogFileName

Type: String

postProcessor

Type: String

precondition

Type: String

procedureName

Type: String

processName

Type: String

processStepName

Type: String

processStepType

Type: String

projectName

Type: String

propertySheet

releaseExclusive

Type: Boolean

releaseMode

Type: String

resourceName

Type: String

resourceSource

Type: String

resourceWaitTime

Type: Number

retries

Type: Number

retryCount

Type: Number

retryInterval

Type: Number

retryType

Type: String

rollbackAppChangeRevision

Type: Number

rollbackSnapshot

Type: String

rollbackUndeployProcess

Type: String

runAsUser

Type: String

runTime

Type: Number

runnable

Type: Date

shell

Type: String

smartRollback

Type: Boolean

start

Type: Date

status

Type: String

stepIndex

Type: Number

stepName

Type: String

subcomponent

Type: String

subcomponentApplication

Type: String

subprocedure

Type: String

subprocess

Type: String

subproject

Type: String

subservice

Type: String

timeLimit

Type: Number

timeout

Type: Date

totalWaitTime

Type: Number

waitTime

Type: Number

workingDirectory

Type: String

workspaceName

Type: String

workspaceWaitTime

Type: Number

license

Contains information to specify the CloudBees Flow license.

Contents:

createTime

customerName

evaluation

expirationDate

featureName

gracePeriod

lastModifiedBy

licenseId

modifyTime

owner

productName

property*

propertySheet*

signature

licenseUsage

Contains information about CloudBees Flow license usage.

The response varies with the license contents.

Contents:

concurrentResources

inUseHosts

inUseProxiedHosts

maxHosts

maxProxiedHosts

concurrentUsers*

adminLicenseLastUse

adminLicenseUser

inUseLicenses

maxLicenses

license*

admin

expiration

lastUse

user

concurrentSteps

maxConcurrentSteps

runningSteps

logEntry

Contains information about log events generated anywhere in the system.

Contents:

category

container

containerName

deleted

logEntryId

message

principal

severity

subject

subjectName

time

object

Primarily, the object element is returned from a getAccess API request. If multiple objects are returned, they are presented in an order beginning with the API requested object to the top-level object in the ACL hierarchy. Your object-query response can contain one or more aclEntry containers.

Contents:

objectId

objectName

objectType

aclEntry *

persona

canonicalPath

Type: String

createTime

Type: Date

description

Type: String

homePageName

Type: String

isDefault

If set to 1 or true, this persona is the system-wide default persona.

Type: Boolean

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

personaId

Type: UUID

personaDetails

List of `personaDetail ` objects.

personaName

Type: String

personaDetail

canonicalPath

string

createTime

date

lastModifiedBy

string

modifyTime

date

owner

string

personaCategory

string

personaDetailId

uuid

personalDetailName

string

personaPages

A list of `personaPage ` objects.

Type: personaPage

tracked

Type: boolean

personaPage

canonicalPath

Type: String

createTime

Type: Date

description

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

personaPageId

Type: UUID

personaPageName

Type: String

url

Type: String

pipeline

acl

Type: ACL

allowCurrentUserToSkipStage

Type: Boolean

assigneesForSkipStage

Type: String

canonicalPath

Type: String

createTime

Type: Date

description

Type: String

disableMultipleActiveRuns

Type: Boolean

disableRestart

Type: Boolean

flow

Type: Flow

hasDeployerTask

Type: Boolean

lastModifiedBy

Type: String

modifyTime

Type: Date

overrideWorkspace

Type: Boolean

owner

Type: String

pipelineEnabled

Type: Boolean

pipelineId

Type: UUID

pipelineName

Type: String

pipelineRunNameTemplate

Type: String

pipelineType

Type: String

projectName

Type: String

propertySheet

PropertySheet

releaseName

Type: String

releaseProjectName

Type: String

requiredParameterCount

Type: Number

skipStageMode

Type: String

stageCount

Type: Number

templatePipelineName

Type: String

templatePipelineProjectName

Type: String

totalParameterCount

Type: Number

tracked

Type: Boolean

userDefinedParameterCount

Type: Number

workspaceName

Type: String

plugin

Contains elements to define the plugin.

Contents:

author

createTime

description

label

lastModifiedBy

modifyTime

owner

pluginId

pluginKey

pluginName

pluginVersion

project

projectName

promoted

propertySheetId

procedure

Contains elements to define the procedure.

Contents:

attachedCredentials

createTime

credentialName

description

jobNameTemplate

lastModifiedBy

modifyTime

owner

procedureId

procedureName

projectName

propertySheetId

resourceName

workspaceName

project

Contains all elements to define a project.

Contents:

attachedCredentials

createTime

credentialName

deleted

description

lastModifiedBy

modifyTime

owner

pluginName

projectId

projectName

propertySheetId

resourceName

workspaceName

property

Contains property sheets and various elements, depending on your query.

Contents:

createTime

description

expandable

lastModifiedBy

modifyTime

owner

path

propertyId

propertyName

propertySheet*

propertySheetId

value

propertySheet

Contains one or more property elements.

Contents:

createTime

lastModifiedBy

modifyTime

owner

property*

propertySheetId

release

acl

Type: ACL

actualEndTime

Type: Date

actualParameters

actualStartTime

Type: Date

canonicalPath

Type: String

createTime

Type: Date

credentialName

Type: String

deployerId

Type: UUID

description

Type: String

disableMultipleActiveRuns

Type: Boolean

disablePipelineRestart

Type: Boolean

lastModifiedBy

Type: String

modifyTime

Type: Date

overrideWorkspace

Type: Boolean

owner

Type: String

pipelineId

Type: UUID

pipelineName

Type: String

pipelineWorkspaceName

Type: String

plannedEndTime

Type: String

plannedStartTime

Type: String

projectName

Type: String

propertySheet

PropertySheet

releaseId

Type: UUID

releaseName

Type: String

releaseStatus

Type: String

timeZone

Type: String

tracked

Type: Boolean

report

acl

Acl

canonicalPath

string

createTime

date

definition

string

definitionComplete

description

string

lastModifiedBy

string

modifyTime

date

owner

string

parameters

string

projectName

string

propertySheet

reportId

uuid

reportName

string

reportObjectTypeDisplayName

string

reportObjectTypeName

string

reportQuery

string

title

string

tracked

uri

string

widgetCount

number

reportingFilter

canonicalPath

Type: String

createTime

Type: Date

dashboardName

Type: String

description

Type: String

lastModifiedBy

Type: String

modifyTime

TYpe: Date

operator

Type: String

orderIndex

Type: Number

owner

Type: String

parameterName

Type: String

projectName

Type: String

reportObjectTypeName

Type: String

reportingFilterId

Type: UUID

reportingFilterName

Type: String

required

Type: Boolean

tracked

Type: Boolean

type

Type: String

widgetName

Type: String

reportObjectAttribute

canonicalPath

Type: String

createTime

Type: Date

description

Type: String

displayName

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

reportObjectAttributeId

Type: UUID

reportObjectAttributeName

Type: String

reportObjectTypeName

Type: String

required

Type: Boolean

type

Type: Enum

reportObjectAssociation

associatedType

Type: String

canonicalPath

Type: String

createTime

Type: Date

description

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

reportObjectAssociationId

Type: UUID

reportObjectTypeName

Type: String

required

Type: Boolean

sourceFields

Type: String

targetFields

Type: String

reportObjectType

acl

Type: ACL

canonicalPath

Type: String

colorCode

Type: String

createTime

Type: Date

defaultUri

Type: String

deleted

Type: Number

description

Type: String

devOpsInsightDataSourceCount

Type: Number

displayName

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

propertySheet

reportObjectAssociationCount

Type: Number

reportObjectAttributeCount

Type: Number

reportObjectTypeId

Type: UUID

reportObjectTypeName

Type: String

sourceType

Type: String

sourceTypeDescription

Type: String

storagePattern

Type: Enum

repository

Contains elements to define the artifact repository. The most useful elements in this object are "repositoryName" and "url". Clients publishing/retrieving artifact versions search repositories by name to obtain connection information.

Contents:

createTime

description

lastModifiedBy

modifyTime

owner

propertySheetId

repositoryDisabled

repositoryId

repositoryIndex

repositoryName

url

zoneName

reservation

reservationId

Type: UUID

reservationName

Type: String

beginDate

Type: Date

blackout

Type: Boolean

createTime

Type: Date

endDate

Type: Date

environmentName

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

overlap

Type: Boolean

owner

Type: String

projectName

Type: String

propertySheetId

recurrence

Type: Boolean

timeZone

Type: Timezone

tracked

Type: Boolean

resourcePool

Contains elements to define a resource pool.

Contents:

autoDelete

createTime

description

lastModifiedBy

lastResourceUsed

modifyTime

orderingFilter

owner

propertySheetId

resourceNames

resourcePoolDisabled

resosurcePoolId

resourcePoolName

resourceUsage

Contains information about resource usage. For any step running on a resource, there is a resource usage record containing the ID and name of the job, job step, and resource.

Contents:

jobId

jobName

jobStepId

jobStepName

licenceWaitTime

resourceId

resourceName

resourcePoolId

resourcePoolName

resourceUsageId

resourceWaitTime

waitReason

workspaceWaitTime

runtimeWaitDependency

acl

Acl

allowCurrentUserToSkip

assigneesForSkip

string

canonicalPath

string

createTime

date

dependentFlowRuntimeId

uuid

dependentGateType

dependentPipelineName

string

dependentProjectName

string

dependentReleaseName

string

dependentStageName

string

dependentTaskName

string

flowRuntimeId

uuid

flowRuntimeStateId

uuid

gateType

lastModifiedBy

string

modifyTime

date

owner

string

pipelineName

string

projectName

string

releaseName

string

runtimeWaitDependencyId

uuid

runtimeWaitDependencyName

string

stageName

string

status

taskName

string

triggeredRun

searchFilter

Contains definition of a custom filter.

Contents:

searchFilterId

searchFilterName

author

createTime

displayName

lastModifiedBy

objectType

owner

propertySheetId

searchQuery

shared

serverStatus

Contains elements to determine the status of the server.

Contents:

apiMonitor

longestCall

api

callId

description

elapsedTime

label

remoteAddress

start

userName

mostActiveCalls

totalCallCount

activeCalls

call*

api

callId

description

elapsedTime

label

remoteAddress

start

userName

recentCalls

call*

api

callId

description

elapsedTime

label

remoteAddress

start

userName

lastMessage

messages

message*

serverState

startTime

serverVersion

Contains elements to specify the CloudBees Flow server version.

Contents:

label

protocolVersion

schemaVersion

version

serviceAccount

acl

Type: ACL

canonicalPath

Type: String

createTime

Type: Date

description

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

propertySheet

serviceAccountId

Type: UUID

serviceAccountName

Type: String

session

canonicalPath

Type: String

createTime

Type: Date

description

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

owner

Type: String

sessionId

Type: UUID

state

Contains elements for a state in a running or completed workflow.

Contents:

active

createTime

description

errorMessage

index

lastModifiedBy

modifyTime

owner

projectName

propertySheetId

stateId

stateName

subjob

subprocedure

subproject

substartingState

subworkflow

subworkflowDefinition

workflowName

stateDefinition

Contains elements for the state definition within a workflow definition.

Contents:

createTime

description

formalParameters

index

lastModifiedBy

modifyTime

owner

projectName

propertySheetId

startable

stateDefinitionId

stateDefinitionName

subprocedure

subproject

substartingState

subworkflowDefinition

workflowDefinitionName

step

Contains elements to specify or define a step.

Contents:

==testDirectoryProvider

Contains the results of testing a directory provider configuration as a list of test result blocks. Each block contains a result with details about any failures. The findGroupsTest block also includes a list of groups for the test user. The findUserTest block includes information about the user or users that matched the test username.

Contents:

findGroupsTest

testResult

details

groupList

group*

findUserTest

testResult

details

userList

userInfo*

email

fullUserName

mutable

providerName

userAuthenticationTest

testResult

details

task

acl

Type: ACL

actionLabelText

Type: String

advancedMode

[0,1] Type: Boolean

afterLastRetry

[continueOnError, stopOnError]

Type: String

allowCurrentUserToApprove

[0,1]

Type: Boolean

allowOutOfOrderRun

[0,1]

Type: Boolean

allowSkip

[0,1]

Type: Boolean

alwaysRun

[0,1]

Type: Boolean

approvers

Type: String

attachedParameters

Type: String

autoRetryInProgress

[0,1]

Type: Boolean

canonicalPath

Type: String

condition

Type: String

createTime

Type: Date

credentialName

Type: String

deployerExpression

Type: String

deployerRunType

[parallel, serial]

Type: String

deployerTask

[0,1]

Type: Boolean

description

Type: String

disableFailure

[0,1]

Type: Boolean

duration

Type: Number

emailConfigName

Type: String

environmentName

Type: String

environmentProjectName

Type: String

environmentTemplateName

Type: String

environmentTemplateProjectName

Type: String

errorHandling

[continueOnError, retryOnError, stopOnError]

Type: String

flow

Flow

flowStateName

Type: String

gateCondition

Type: String

gateName

Type: String

groupName

Type: String

groupRunType

[parallel, serial]

Type: String

hasWaitDependencies

[0,1]

Type: Boolean

index

Type: Number

instruction

Type: String

lastModifiedBy

Type: String

modifyTime

Type: Date

notificationEnabled

[0,1]

Type: Boolean

notificationTemplateName

Type: String

owner

Type: String

outOfOrderRunAssignees

List of users that can pre-run a task out of order.

Type: <users>

parallelToPrevious

[0,1]

Type: Boolean

parentFlowName

Type: String

performedRetryCount

Type: Number

plannedEndDate

Type: String

plannedStartDate

Type: String

precondition

Type: String

propertySheet

PropertySheet

releaseName

Type: String

requiredApprovalsCount

Type: Number

requiresDefinition

[0,1]

Type: Boolean

resourceName

Type: String

retryCount

Type: Number

retryInterval

Type: Number

retryType

[auto, manual]

Type: String

rollingDeployEnabled

[0,1]

Type: Boolean

rollingDeployManualStepAssignees

Type: String

rollingDeployManualStepCondition

[always, failure, success]

Type: String

rollingDeployPhases

Type: String

snapshotName

Type: String

stageId

Type: UUID

stageName

Type: String

stageSummaryParameters

Type: String

startTime

Type: Date

startingStage

Type: String

subErrorHandling

[continueOnError, stopOnError]

Type: String

subapplication

Type: String

subflow

Type: String

subpipeline

Type: String

subpluginKey

Type: String

subprocedure

Type: String

subprocess

Type: String

subproject

Type: String

subrelease

Type: String

subreleasePipeline

Type: String

subreleasePipelineProject

Type: String

subreleaseSuffix

Type: String

subservice

Type: String

subworkflowDefinition

Type: String

subworkflowStartingState

Type: String

taskApprovers

Type: String

taskCount

Type: Number

taskEnabled

[0,1]

Type: Boolean

taskId

Type: UUID

taskName

Type: String

taskProcessType

[APPLICATION, OTHER, SERVICE]

Type: String

taskSkippable

[0,1]

Type: Boolean

taskType

[APPROVAL, COMMAND, CONDITIONAL, DEPLOYER, GROUP, MANUAL, PIPELINE, PLUGIN, PROCEDURE, PROCESS, RELEASE, UTILITY, WORKFLOW]

Type: String

timeZone

Type: String

tracked

[0,1]

Type: Boolean

triggerType

[async, sync]

useApproverAcl

[0,1]

Type: Boolean

waitForPlannedStartDate

[0,1]

Type: Boolean

waitingForDependency

[0,1]

Type: Boolean

waitingForManualRetry

[0,1]

Type: Boolean

waitingForPlannedStartDate

[0,1]

Type: Boolean

waitingForPrecondition

[0,1]

Type: Boolean

waitingOnManual

[0,1]

Type: Boolean

workflowName

Type: String

transition

Contains elements about a transition in a running or completed workflow.

Contents:

actualParameters

condition

createTime

description

index

lastModifiedBy

modifyTime

owner

projectName

propertySheetId

stateName

targetState

transitionId

transitionName

trigger

workflowName

transitionDefinition

Contains elements about a transition definition within a workflow definition.

Contents:

actualParameters

condition

createTime

description

index

lastModifiedBy

modifyTime

owner

projectName

propertySheetId

stateDefinitionName

targetState

transitionDefinitionId

transitionDefinitionName

trigger

workflowDefinitionName

user

Contains information about the current user.

canonicalPath

Type: String

createTime

Type: Date

email

Type: String

fullUserName

Type: String

lastLoginTime

Type: Date

lastModifiedBy

Type: String

modifyTime

Type: Date

mutable

If True, the member list of this group is editable within CloudBees Flow via the web UI or the modifyGroup API.

Type: Boolean

owner

Type: String

propertySheet

providerName

Type: String

registered

Type: Boolean

userId

Type: UUID

userName

Type: String

waitDependency

allowSkip

assigneesForSkip

string

canonicalPath

string

createTime

date

dependentGateType

dependentPipelineName

string

dependentProjectName

string

dependentReleaseName

string

dependentStageName

string

dependentTaskName

string

flowStateName

string

gateType

lastModifiedBy

string

modifyTime

date

owner

string

pipelineName

string

projectName

string

releaseName

string

stageName

string

taskName

string

tracked

waitDependencyId

uuid

waitDependencyName

string

waitForTriggeredPipelines

waitForTriggeredReleases

widget

acl

Acl

actualParameters

attributeDataTypes

attributePaths

canonicalPath

string

colorRanges

string

colors

createTime

date

dashboardName

string

description

string

iconUrl

string

lastModifiedBy

string

linkParameters

linkTarget

string

modifyTime

date

orderIndex

number

owner

string

phase

string

projectName

string

propertySheet

propertySheet

reportName

string

reportProjectName

string

reportingFilterCount

number

resolvedTitle

string

section

title

string

tracked

visualization

[ AREA_CHART, CUSTOM_CHART, DONUT_CHART, GROUPED_HORIZONTAL_BAR_CHART, GROUPED_VERTICAL_BAR_CHART, HORIZONTAL_BAR_CHART, LINE_CHART, METRIC, STACKED_AREA_CHART, STACKED_HORIZONTAL_BAR_CHART, STACKED_VERTICAL_BAR_CHART, TABLE, VERTICAL_BAR_CHART ]

visualizationProperties

propertySheet

widgetFilterOverrideCount

number

widgetId

uuid

widgetName

string

widgetFilterOveride

canonicalPath

Type: String

createTime

Type: date

dashboardFilterName

Type: String

dashboardName

Type: String

description

Type: String

ignoreFilter

Type: Boolean

lastModifiedBy

Type: String

modifyTime

Type: date

owner

Type: String

parameterName

Type: String

projectName

Type: String

tracked

Type: Boolean

widgetFilterOverrideId

Type: UUID

widgetName

Type: String

workflow

Contains elements about a running or completed workflow.

Contents:

activeState

callingState

completed

createTime

deleted

elapsedTime

finish

lastModifiedBy

launchedByUser

liveWorkflowDefinition

modifyTime

owner

projectName

propertySheetId

start

startingState

workflowDefinitionName

workflowId

workflowName

workflowDefinition

Contains elements about a workflow definition.

Contents:

createTime

description

lastModifiedBy

modifyTime

owner

projectName

propertySheetId

workflowDefinitionId

workflowDefinitionName

workflowNameTemplate

WorkItem

The response payload for the WorkItem ` object consists of the set of parameters common to all wait types and a set of context-specific parameters based on the value of `waitingEntityType.

  • Common parameters --returned in all `WaitItem ` response payloads.

anyUser

0—Only specified users/groups can perform action on waiting object.

1—Any user can perform action on waiting object. Used for manual or approval tasks without approvers or with unresolved approvers.

Type: Boolean

createTime

Type: Date

groups

The list of groups whose users can perform an action on a waiting object.

Type: Set <String>

lastModifiedBy

TYpe: String

modifyTime

Type : Date

owner

Type: String

projectName

Name of the project containing the waiting entity.

Type: String

users

The list of users who can perform an action on a waiting object.

Type: Set <String>

waitingEntityType

The specific type of waiting entity. Possible values:

flowRuntimeState

jobStep

workflow

See sub-sections below for the context-specific parameters returned based on waitingEntityType.

Type: String

workItemId

Type: uuid

workItemName

Type: String

  • Context specific parameters —Based on the value of waitingEntityType, the rest of the parameters in the response payload varies.

waitingEntityType = flowRuntimeState

flowRuntimeId

Type: uuid

gateType

Required for `completeManualTask ` or `retryTask ` operations.Possible values:

PRE

POST

Type: string

pipelineName

Type: string

releaseName

Type: string

stageName

Required for `completeManualTask ` or `retryTask ` operations.

Type: string

subapplication

Required for the `retryTask ` operation in the context of a deployer application.

Type: string

subproject

Required for the `retryTask ` operation in the context of a deployer application or service.

Type: string

subservice

Required for the `retryTask ` operation in the context of a deployer service.

Type: string

taskName

Required for `completeManualTask ` or `retryTask ` operations.

Type: string

waitingEntityId

The flowRuntimeStateId.

Type: uuid

waitingType

Indicates which operation to call to complete the item. Possible values:

onApproval

onRetry

Type: String

waitingEntityType = jobStep

applicationName

Type: String

processName

Type: String

processStepName

Type: String

serviceName

Type: String

waitingEntityId

The jobStepId. This is required for calling completeManualProcessStep ` or `retryProcessStep operations.

Type: uuid

waitingType

Indicates which operation to call to complete the item. Possible values:

onApproval

onRetry

Type: String

waitingEntityType = workflow

subproject

Use this in calls to the `retryTask ` operation.

Type: string

waitingEntityId

The workflowID.

Type: uuid

waitingType

Possible value: onApproval

Type: String

workflowName

Type: String

workflowStateName

The active state.

Type: String

workspace

Contains elements about a workspace.

Contents:

agentDrivePath

agentUncPath

agentUnixPath

createTime

credentialName

description

lastModifiedBy

local

modifyTime

owner

propertySheet

propertySheetId

workspaceDisabled

workspaceId

workspaceName

zoneName

zone

Contains elements about a zone.

Contents:

createTime

description

lastModifiedBy

modifyTime

owner

propertySheetId

resources

zoneId

zoneName

Element Glossary

The following table lists all simple returned elements, including the element type and its description.

Returned element Type Description/Value

abortStatus

enum

Possible values are: abort|force_abort

abortedBy

string

The name of the user who aborted the job.

aclEntryId

number

The unique CloudBees Flow-generated ID for this aclEntry object.

active

boolean

< Boolean flag — 0|1|true|false >—If set to "true", the state of the workflow is active.

activeCalls

subcontainer

A container element within the serverStatus element. activeCall describes an API currently running on the server.

activeState

string

The name of the activeState on the workflow object.

actualParameters

propertySheet

An actualParameter object provides the value for a parameter, which is passed to a procedure when it is invoked. Actual parameters can be provided for jobs and nested subprocedures within a job. Actual parameters are different from "formal parameters"- formal parameters define the parameters a procedure is expecting, and actual parameters provide values to use at run-time. For the workflow feature, these are the parameters that were passed when the workflow was started.

actualParameterId

number

The unique CloudBees Flow-generated ID for this actual parameter object.

actualParameterName

string

The name of the parameter. This name is unique within the step, and at runtime it matches the name of a formal parameter in the subprocedure.

admin

boolean

< Boolean flag — 0|1|true|false >—If set to "true", the this is an "admin" license.

adminLicenseLastUse

date

The time at which the admin license was last used.

adminLicenseUser

string

The name of the user who is currently licensed as the "admin" user.

agentDrivePath

string

Drive-letter-based path used by Windows agents to access the workspace in steps.

agentUncPath

string

UNC path used by Windows CloudBees Flow Web servers to access the workspace. The agent uses agentUncPath and agentDrivePath to compute the drive mapping needed for making agentDrivePath valid in the step.

agentUnixPath

string

UNIX path used by UNIX agents and Linux CloudBees Flow Web servers to access the workspace.

agentState

subcontainer

A subcontainer element returned from certain resource queries. agentState returns specific information about an agent, including the state of the agent. Possible values are: unknown|alive|down

alive

boolean

Refers to the agent state or status.

alwaysRun

boolean

< Boolean flag — 0|1|true|false >— If set to 1, indicates this step will run even if the job is aborted before the step completes. Defaults to "false".

api

string

An element returned on longestCall, activeCall, and recentCall subcontainers of the serverStatus element. api returns the API call (command) that is running or ran on the server.

apiMonitor

A server object that tracks API active, recent calls, and the total number of calls since server startup.

artifactCacheDirectory

string

The directory on the agent host where retrieved artifacts are stored.

artifactId

number

The unique CloudBees Flow-generated ID for this artifact object.

artifactKey

string

User-specified identifier for this artifact. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods.

artifactName

string

The name of the artifact.

artifactsDirectory

string

The directory in the workspace where you can put files to view, using a report link.

artifactVersionId

string

The unique CloudBees Flow-generated ID for this artifact version object.

artifactVersionName

name

The name of the artifact version. An artifact version name is interpreted by the server as the artifactVersionName attribute for the artifactVersion in question. This name is parsed and interpreted as "groupId:artifactKey:version" and the object is searched either way you specify its name—the CloudBees Flow server interprets either name form correctly.

artifactVersionNameTemplate

string

A template for the names of artifact versions published to this artifact. Over-rides the global artifactVersionNameTemplate. The global setting can be manipulated in the Server Settings page (Administration > Server, select the Settings link).

artifactVersionState

enum

Possible values are: available|publishing|unavailable

assignedResourceName

string

The name of the resource assigned to the step by the resource scheduler.

attachedCredentials

list

The names of the credentials attached to the specified object.

attachedParameters

string

These are credential parameters that were attached to a step.

author

string

The author of the plugin.

autoDelete

boolean

< Boolean flag — 0|1|true|false >— If "true", the resource pool is deleted when the last resource is removed or deleted.

batchRequests

string

A setting in the database configuration that determines whether or not to batch SQL queries when making a request to the database.

batchSize

string

The number of objects imported before being committed to the database.

beginDate

string

< yyyy-mm-dd > The date the schedule is set to begin.

broadcast

boolean

< Boolean flag — 0|1|true|false >— Used for command steps, this flag is used to run the same step on several resources at the same time. The step is “broadcast” to all resources listed in the resourceName argument. Defaults to "false".

buildNumber

string

User-defined build number component of the version attribute for the artifact version.

call

subcontainer

A subcontainer returned on activeCall and recentCall elements returned by the serverStatus API. call contains information specific to each API call on the server.

callId

number

A unique CloudBees Flow-generated identifier for this particular call.

callingState

string

The full property path to the "calling state", which can appear on subjobs and subworkflows of a workflow.

calledProcedure

list

A subcontainer element within the jobStep element. The calledProcedure element can contain multiple jobStep elements.

category

(Not used)

changePermissionsPrivilege

enum

Possible values are: ` allow|deny|inherit`

code

enum

Script to execute the functions for a step—passed to the step’s shell for execution.

combinedStatus

enum

More inclusive step status output—this value may combine up to three sub-elements: status|message|properties

command

string

The command to run steps—for command steps.

commonGroupNameAttribute

string

The attribute in a group record that contains the common group name. If specified, this name is used only when searching for groups from an external provider.

completed

boolean

< Boolean flag — 0|1|true|false >— If "true", the workflow is completed and no additional transactions will be evaluated.

completeUserName

string

A SQL server-specific tag that includes the user’s name and the user’s domain name.

concurrentResources

object

A subcontainer element that includes information about "in use" and "maximum licensed" hosts and proxied hosts for the licenseUsage API command.

concurrentSteps

number

The total number of steps running at the same time in the CloudBees Flow system. This means all steps from all procedures, regardless of how many or how few projects you have created.)

concurrentUsers

object

A subcontainer element that includes information about the admin license, "in use" licenses, and the maximum number of licenses for the licenseUsage API command.

condition

string

For steps: If empty or non-zero, the step will run. If set to "0", the step is skipped. A useful setting during procedure development or when re-running a job that has already completed some of the steps. Also, this argument is useful for conditional execution of steps based on properties set by earlier steps. For email notifiers: Mail sent if the condition evaluates to "true". The condition is a string subject to property expansion. The notification will NOT be sent if the expanded string is "false" or "0". If no condition is specified, the notification is ALWAYS sent.

configName

string

The name of the configuration.

container

string

An object ID for a "container" that contains formal parameters. In another context, this is typically the type and name of the workflow or job with a corresponding ID.

containerName

string

The name of the container.

createTime

date

The time when this object was created.

credentialId

number

The unique CloudBees Flow-generated ID for this credential object.

credentialName

string

credentialName can be one of two forms: relative (for example, "cred1" )—the credential is assumed to be in the project that contains the request target object. Requires a qualifying project name. absolute (for example, "/projects/BuildProject/credentials/cred1" ) —the credential can be from any specified project, regardless of the target object’s project.

customDatabaseDialect

string

Class name for the Hibernate dialect. The server chooses an appropriate dialect based on databaseType or this can be part of the custom specification.

customDatabaseDriver

string

Class name of the JDBC driver. The server will choose an appropriate driver based on databaseType or this can be part of the custom specification.

customDatabaseUrl

string

The JDBC URL to use. The server will compose an appropriate URL or this can be part of the custom specification.

customerName

string

The name of a company or group name with a company that is using CloudBees Flow.

databaseDialect

string

Class name for the Hibernate dialect (the server chooses an appropriate dialect based on databaseType ).

databaseDriver

string

Class name of the JDBC driver (the server will choose an appropriate driver based on databaseType ).

databaseName

string

The name of the database the CloudBees Flow server is using.

databaseType

enum

Possible values are: builtin|mysql|oracle|postgresql|sqlserver

databaseUrl

string

The JDBC URL to use (the server will compose an appropriate URL).

defaultValue

string

This value is used for the formal parameter if a value is not supplied by the caller.

delayUntil

date

For a step that was rescheduled due to a resource or workspace problem, this is the next time when the step will be eligible to run.

deleted

byte

The object was marked for background deletion. Possible values are "0" or "1". Default is "0" (not set).

dependentArtifactVersions

list

A list of one or more artifact versions.

description

string

(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. Allowable HTML tags are <a>, <b>, <br>, <div>, <dl>, <font>, <i>, <li>, <ol>, <p>, <pre>, <span>, <style>, <table>, <tc>, <td>, <th>, <tr>, and <ul>.

For example, the following HTML:

<p>
<span style="font-family: Arial;">
  <i>Note:</i> For more information about the <b>abc</b> object, see
         <a href="https://www.google.com/">\https://www.google.com</a>.
</span>
</p>

renders as follows:

_Note:_ For more information about the *abc* object, see \https://www.google.com.

destinations

string

A space-separated list of valid email addresses, email aliases, or CloudBees Flow user names, or a string subject to property expansion that expands into such a list.

details

string

A string containing details about agent status.

directoryName

string

The name of the job’s directory within each workspace for a job.

directoryProviderId

number

The unique CloudBees Flow-generated ID for this directory provider object.

displayName

string

External custom filter name as displayed in the UI.

domainName

string

The name of the domain from which the Active Directory servers are automatically discovered.

elapsedTime

number

The number of milliseconds between the start and end times for the job or job step—or a workflow.

email

string

The user’s email address.

emailAttribute

string

The attribute in a user record that contains the user’s email address. If the attribute is not specified, the account name and domain name are concatenated to form an email address.

emailConfigId

number

The unique CloudBees Flow-generated ID for this email configuration object.

emailConfigName

string

The name of the email configuration.

emailNotifierId

number

The unique CloudBees Flow-generated ID for this email notifier object.

enableGroups

boolean

Determines whether or not to enable external groups for the directory provider.

endDate

string

< yyyy-mm-dd > The date this schedule is set to end.

errorCode

enum

Displays the error code, identifying which error occurred.

errorHandling

enum

Determines what happens to the procedure if the step fails:

  • failProcedure —The current procedure continues, but the overall status is error (default).

  • abortProcedure —Aborts the current procedure, but allows already-running steps in the current procedure to complete.

  • abortProcedureNow —Aborts the current procedure and terminates running steps in the current procedure.

  • abortJob —Aborts the entire job, terminates running steps, but allows alwaysRun steps to run.

  • abortJobNow —Aborts the entire job and terminates all running steps, including alwaysRun steps.

  • ignore —Continues as if the step succeeded.

errorMessage

string

A description of the error.

evaluation

boolean

Determines whether or not this license is an evaluation copy only.

eventType

enum

Possible values are: onCompletion|onStart "onStart" triggers an event when the job or job step begins. "onCompletion" triggers an event when the job finishes, no matter how it finishes. Default is "onCompletion".

exclusive

boolean

< Boolean flag — 0|1|true|false >— If set to 1, indicates this step should acquire and retain this resource exclusively. Defaults to "false".

exclusiveJobId

number

The ID number of the job that owns this resource, which occurs when one of the job’s steps requests exclusive use of the resource for the duration of the job.

exclusiveJobName

string

The name of the job that owns this resource, which occurs when one of the job’s steps requests exclusive use of the resource for the duration of the job.

exclusiveJobStepId

number

The ID number of the job step that owns this resource, which occurs when one of the steps request exclusive use of the resource for the duration of the job.

exclusiveJobStepName

name

The name of the job step that owns this resource, which occurs when one of the steps request exclusive use of the resource for the duration of the job.

exclusiveMode

enum

Possible values are: none|job|step|call See exclusive.

executePrivilege

enum

Possible values are: allow|deny|inherit

exitCode

number

The step’s exit code.

expandable

boolean

< Boolean flag — 0|1|true|false > Determines whether the property value will undergo property expansion when it is fetched. Default is "true".

expansionDeferred

boolean

< Boolean flag - 0|1|true|false > Default is "false," which means the formal parameter is expanded immediately.

expiration

date

The date when a user license expires.

expirationDate

date

The date when a license expires.

external

boolean

< Boolean flag - 0|1|true|false > If "true," this job is external. For more information about external jobs, see Job Management .

featureName

string

The name of the licensed feature. Possible features include: Server

findGroupsTest

subcontainer

For the testDirectoryProvider API, this element provides information on which groups the user is a member.

findUserTest

subcontainer

For the testDirectoryProvider API, this element contains specific information about the user.

finish

date

The time the job or workflow completed.

formalParameterId

number

The formal parameter’s ID.

formalParameterName

string

The name of the procedure’s parameter, containing a credential reference.

formalParameters

string

The parameters that must be supplied when entering the state (similar to formal parameters on a procedure).

formattingTemplate

string

Specifies a template for formatting email messages when an event [notification] is triggered by the emailNotifier.

fullUserName

string

The user’s full name—not his or her nickname.

fullUserNameAttribute

string

The attribute in a user record that contains the user’s full name (first and last) for display in the UI. If this attribute is not specified or the resulting value is empty, the user’s account name is used instead.

gatewayDisabled

boolean

< Boolean flag - 0|1|true|false > If "true", the gateway is disabled.

gatewayId

number

The CloudBees Flow-generated ID number for this gateway.

gatewayName

string

The name of the gateway.

gateways

list

A space-separated list of gateway names.

gracePeriod

number

The number of days available after the CloudBees Flow license expires.

groupBase

string

This string is prepended to the basedn to construct the directory DN that contains group records.

groupId

number

The unique CloudBees Flow-generated group ID. For Artifact Management: A user-generated group name for this artifact. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods.

groupList

list

For the testDirectoryProvider API, this element contains zero or more groups returned after querying existing groups known to the directory provider.

groupMemberAttributes

string

A comma-separated attribute name list that identifies a group member. Most LDAP configurations only specify a single value, but if there is a mixture of POSIX and LDAP style groups in the directory, multiple attributes might be required.

groupMemberFilter

string

This LDAP query is performed in the groups directory context to identify groups containing a specific user as a member. Two common forms of group record in LDAP directories: POSIX style groups where members are identified by account name, and groupOfNames or uniqueGroupOfNames records where members are identified by the full user DN. Both forms are supported, so the query is passed to parameters: "{0}" is replaced with the full user record DN, and "{1}" is replaced with the user’s account name.

groupName

string

The full name of a group. For Active Directory and LDAP, this is a full DN.

groupNameAttribute

string

The group record attribute that contains the name of the group.

groups

list

A space-separated list of group names.

groupSearchFilter

string

The LDAP query performed in the context of the groups directory to enumerate group records.

groupSettingsId

number

The unique CloudBees Flow-generated ID for this group settings object.

hostName

string

The computer name or IP address for the machine containing the CloudBees Flow server or agent.

hostName1

string

For gateways: The name Resource 2 uses to communicate with Resource 1. If "blank", the Agent Host Name attribute in Resource 1’s definition is used at runtime.

hostName2

string

For gateways: The name Resource 1 uses to communicate with Resource 2. If "blank", the Agent Host Name attribute in Resource 2’s definition is used at runtime.

hostOS

string

The full name of the host operating system, plus its version. However, if this host is a proxy, the value is "proxied".

hostPlatform

string

Examples for "platform" are: Windows, Linux, HPUX, and so on. However, if this host is a proxy, the value is "proxied".

index

number

The numeric index of the transition that indicates its order in the list of transitions in a state definition.

interval

string

The repeat interval for starting new jobs.

intervalUnits

enum

Possible values are: hours|minutes|seconds|continuous If set to continuous, CloudBees Flow creates a new job as soon as the previous job completes.

inUseHosts

number

The number of hosts (agents) currently in use.

inUseLicenses

number

The number of user licenses currently in use.

inUseProxiedHosts

number

The number of proxy target hosts currently in use.

jobId

number

The unique CloudBees Flow-generated identifier (a UUID) for a job that is assigned automatically when the job is created. The system also accepts a job name assigned to the job by its name template.

jobName

string

The name of the job.

jobNameTemplate

string

Template used to determine the default name of jobs launched from a procedure.

jobStepId

number

The unique identifier for a job step, assigned automatically when the job step is created.

jobStepName

string

The name of the job step.

label

string

A name used by a plugin for display in a list, or this may represent context-specific info about an API call—not all API calls return a "label" tag.

lastMessage

string

Element returned by the serverStatus API showing the last message the server received.

lastModifiedBy

string

Shows who (generally a username) last modified the object.

lastResourceUsed

string

The name of the most recently used resource from the pool.

lastRunTime

date

The last time a job was launched by a schedule. -or- In a resource response, this is the most recent time that a job step ran on the resource.

lastUse

Returned element in the concurrentUsers subcontainer (for the licenseUsage API), providing the last time a specific user accessed CloudBees Flow.

launchedByUser

string

The name of the user or project principal that explicitly launched the job. This property is blank when the job is launched by a schedule.

licenseId

number

The unique CloudBees Flow-generated ID for this license.

licenseWaitTime

The amount of time a job step was stalled waiting for an available license. On a job, this is the sum of license wait for all job steps.

liveProcedure

string

Shows the current procedure name for the procedure step from which the job or job step was created – if the procedure step was renamed since the job or job step was launched, this is the procedure step’s new name, and if the procedure step was deleted, this will be null.

liveProcedureStep

string

Shows the current procedure step name for the procedure step from which the job step was created – if the procedure step was renamed since the job was launched, this is the procedure step’s new name, and if the procedure step was deleted, this will be null.

liveSchedule

string

Shows the current schedule name for the procedure step from which the job was created – if the schedule was renamed since the job was launched, this is the schedule’s new name, and if the schedule was deleted, this will be null.

liveWorkflowDefinition

string

Shows the current workflow definition name for the workflow definition from which the workflow was created – if the workflow definition was renamed since the workflow was launched, this is the workflow definition’s new name, and if the workflow definition was deleted, this will be null.

local

boolean

< Boolean flag - 0|1|true|false > If "true", this object is local.

logEntryId

number

The CloudBees Flow-generated ID number for the log entry record.

logFileName

string

A custom log file name produced by running the step. By default, CloudBees Flow assigns a unique name for this file.

longestCall

string

Provides the API call that took the longest time.

mailFrom

string

The email address used as the email sender address for notifications.

mailHost

string

The name of the email server host.

mailPort

number

The port number for the mail server, but may not need to be specified. The protocol software determines the default value (25 for SMTP and 465 for SSMTP). Specify a value for this argument when a non-default port is used.

mailProtocol

string

This is either SSMTP or SMTP (not case-sensitive). The default is SMTP.

mailUser

string

This can be an individual or a generic name like "CloudBees Flow"—name of the email user on whose behalf CloudBees Flow sends email notifications.

majorMinorPatch

string

major.minor.patch component of the version attribute for the artifact.

managerDn

string

The name of a user who has read-only access to the LDAP or Active Directory server. Typically a DN (distinguished name). A simple name may be used when the Active Directory server’s URL is being auto-discovered via DNS.

This user does not need to be an admin user with modify privileges.

maxConcurrentSteps

number

The maximum number of steps that can run at the same time per the provisions of your CloudBees Flow license.

maxHosts

number

The maximum number of hosts licensed for resource use.

maxLicenses

number

The maximum number of licenses available for users.

maxProxiedHosts

number

The maximum number of available licenses for proxy hosts.

message

string

A user-readable diagnostic message associated with an error.

messages

list

Multiple error or diagnostic messages.

misfirePolicy

enum

Possible values are: ` ignore | run once` A schedule may not fire at the allotted time because a prior job is still running, the server is running low on resources and there is a delay, or the server is down. When the underlying issue is resolved, the server will schedule the next job at the next regularly scheduled time slot if the policy is ` 'ignore'`, otherwise it will run the job immediately. Defaults to "ignore".

modifyPrivilege

enum

Possible values are: allow|deny|inherit

modifyTime

date

The time when the object was last modified.

monthDays

string

Restricts the schedule to specified days of the month. Specify numbers from 1-31, separating multiple numbers with a space.

mostActiveCalls

number

The number of most active API calls since server startup.

mutable

boolean

If "true," the member list of this group is editable within CloudBees Flow via the web UI or the modifyGroup API.

name

string

The name of the directory provider.

notifierName

string

The name of the email notifier.

objectId

number

An object identifier returned by findObjects and getObjects. This value is a "handle" only for passing to API commands. The internal structure of this value is subject to change—do not parse this value.

objectName

string

The name of the object.

objectType

enum

The type of object being described, for example: project, procedure, step, and so on.

orderingFilter

string

A Javascript block invoked when scheduling resources for a pool.

A Javascript block is not required unless you need to override the default resource ordering behavior.

outcome

enum

Possible values for outcome : Note: The outcome is accurate only if the job status is "completed." success — The job finished successfully. warning —The job completed with no errors, but encountered some suspicious conditions. error —The job has finished execution with errors.

owner

string

The person (username) who created the object.

parallel

boolean

< Boolean flag — 0|1|true|false >— If set, indicates this step should run at the same time as adjacent steps marked to run as parallel also. Defaults to "false".

password

string

The password matching the specified username.

path

string

The property path that specifies the object to use.

pingToken

number

Every time an agent starts, a unique pingToken value is generated. The server uses the pingToken value to determine agent restarts by noticing the values before and after a restart.

pluginId

number

The unique CloudBees Flow-generated ID for the plugin object.

pluginKey

string

The name of the plugin as displayed on the CloudBees Flow Plugin Manager web page.

pluginName

string

The name of the plugin—the plugin key for a promoted plugin or a plugin key and version for an unpromoted plugin.

pluginVersion

string

The version of the plugin being described.

pools

list

A space-separated list of one or more pool names where this resource is a member. Steps defined to run on a resource pool will run on any available member (resource) in the pool.

port

number

If a port number is not specified, the default CloudBees Flow port is used. For a proxy resource, this is the port number for the service running on the proxy target that will run commands on behalf of the CloudBees Flow agent. For ssh, the default is 22.

port1

number

The port number used by Gateway Resource1 —default is to the port number used by the resource.

port2

number

The port number used by Gateway Resource2 —default is to the port number used by the resource.

position

number

Used to reorder a CloudBees Flow object. For example, if reordering directory providers: the provider name is moved to a position just before this provider. "Blank" means move the provider to the end of the provider list.

postExitCode

number

The step’s post processor exit code.

postLogFileName

string

The log file name produced by this step’s post processor.

postProcessor

string

This program looks at the step output to find errors and warnings. CloudBees Flow includes a customizable program called “postp” for this purpose. The value for postProcessor is a command string for invoking a post-processor program in the platform shell for the resource ( cmd for Windows, sh for UNIX).

precondition

string

Set this property to make a step wait until one or more dependent conditions are met. When a job step is eligible to transition from pending to runnable, a precondition is evaluated. A precondition is a fixed text or text embedding property reference that is evaluated to TRUE or FALSE. An empty string, a \"0\" or \"false\" is interpreted as FALSE. Any other result string is interpreted as TRUE. The step will block until the precondition is TRUE.

principal

string

The user or project principal from the session that was active when the event occurred.

principalName

string

This is either a user or a group name.

principalType

enum

Possible values are: group|user

priority

enum

Possible values are: ` low|normal|high|highest` Priorities take effect when two or more job steps in different jobs are waiting for the same resource. When the resource is available, it will be used by the job step that belongs to the job with the highest priority. If the priority level is the same, the resource will be used by the job step that belongs to the job with the lowest job ID number. If the job steps are in the same job, the resource will be used first by the step with the lowest job step ID number.

procedureId

number

The unique CloudBees Flow-generated procedure ID.

procedureName

string

The name of the procedure—may be a path to the procedure.

productName

string

The name of the product with the licensed feature. Possible products include: CloudBees Flow

project

name

The name of the project associated with the plugin.

projectId

number

The unique CloudBees Flow-generated project ID.

projectName

string

The name of the project—may be a path. The project name is ignored for credentials, procedure, steps, and schedules if it is specified as a path.

promoted

boolean

< Boolean flag — 0|1|true|false > The new value of the promoted flag for the specified plugin. Default is "true", which means the plugin will be promoted. If you want to demote the plugin, use the value of “0” or false.

propertyId

number

The unique CloudBees Flow-generated property ID.

propertyName

string

The name of the property. It may be a relative or absolute property path, including "my" paths such as "/myProject/prop1".

propertySheetId

number

The unique identifier for a property sheet, assigned automatically when the property sheet is created.

protocolVersion

sting

The server API protocol version. For example, the server accepts messages from ectool and ec-perl.

providerIndex

number

The index that specifies the search order across multiple directory providers. For example: 2 LDAP providers, one with index "0" and one with index "1" means the providers will be searched in that numerical order.

providerName

string

The LDAP or Active Directory provider name.

providerType

enum

Possible values are: ldap|activedirectory

proxyCustomization

string

Perl code customizing how the proxy resource communicates with the proxy target. This argument is applicable only for proxy resources.

proxyHostName

string

The name or IP address of the computer containing the CloudBees Flow Agent used for a proxy resource.

proxyPort

number

The CloudBees Flow agent port number for a proxy resource.

proxyProtocol

string

Protocol for communicating with the proxy target. Defaults to ssh. (This argument is not exposed in the CloudBees Flow Web Interface at this time.)

publisherJobId

number

The CloudBees Flow-generated ID for the job that published the artifact version.

publisherJobName

name

The name of the job that published the artifact version.

publisherJobStepId

number

The CloudBees Flow-generated ID for the job step that published the artifact version.

qualifier

string

User-defined qualifier component of the version attribute for the artifact.

readPrivilege

enum

Possible values are: allow|deny|inherit

realm

string

The realm of the LDAP directory provider—used to create unique user names when there are multiple providers.

recentCall

subcontainer

A subcontainer element on the serverStatus API—a call no longer active (completed). The API monitor keeps track of the 10 most recent calls.

releaseExclusive

boolean

< Boolean flag — 0|1|true|false > Declares whether or not this step will release its resource, which is currently held exclusively.

releaseMode

string

Possible values are: none|release|releaseToJob

remoteAddress

string

Generally a combined IP address plus a port specification—used when the agent is talking to the server or to show where the request to the server originated.

repositoryDisabled

boolean

< Boolean flag — 0|1|true|false > Determines whether the repository is disabled. Default is "false".

repositoryId

number

The CloudBees Flow-generated ID for the artifact repository.

repositoryIndex

integer

The order of the repository within a list of repositories.

repositoryName

string

The name of the artifact repository.

repositoryNames

list

A list of one or more repository server names—each repository name listed on a "new line".

required

boolean

< Boolean flag — 0|1|true|false > If set to 1, this value indicates whether a non-blank value must be supplied when calling the procedure.

resourceDisabled

boolean

< Boolean flag — 0|1|true|false > If set to 1, CloudBees Flow will not start new steps on this resource. Defaults to "false".

resourceId

number

The unique CloudBees Flow-generated ID for this resource.

resourceName1

string

The name for the first of two resources required to create a gateway. "Spaces" are NOT allowed in a resource name.

resourceName2

string

The name for the second of two resources required to create a gateway. "Spaces" are NOT allowed in a resource name.

resourceName

string

The name of a resource.

resourceNames

string

A list of strings that refer to resources that belong to the pool. Names that do not refer to existing resources are ignored.

resourcePoolDisabled

boolean

< Boolean flag — 0|1|true|false > If set to 1, CloudBees Flow will not use resources in this pool. Defaults to "false".

resourcePoolId

number

The unique ID number for a resource pool.

resourcePoolName

name

The name of the resource pool.

resources

string

A space-separated list of resource names.

resourceUsageId

number

The unique ID number of the resource usage record.

resourceWaitTime

The amount of time a job step waited for a resource to become available. On a job, this is the sum of time all job steps waited for resource availability. This could indicate that eligible resources for the step have reached their step limit, are in-use but the step requires a resource exclusively, or resources are down.

retries

number

The number of attempts to write to the step log in the workspace. In a running step, this is the number of retries attempted up to this point. The most common reason for step retries is the workspace for the step was unavailable.

retrievers

list

A collection of retrieve elements that can contain a jobName, jobId, and/or a jobStepId elements.

runAsUser

string

The name of the user being impersonated in this job.

runnable

date

The time when the step became runnable.

runningSteps

The number of steps running at the same time.

runtime

number

The number of milliseconds the step command spent running on a resource.

scheduleDisabled

boolean

< Boolean flag — 0|1|true|false > If set to 1, CloudBees Flow does not start any new jobs from the schedule. Defaults to "false".

scheduleId

number

The unique, CloudBees Flow-generated ID for the schedule.

scheduleName

string

The name of the schedule—may be a path to the schedule.

schemaVersion

number

The CloudBees Flow server’s database schema version.

searchFilterId

number

The unique, CloudBees Flow-generated ID for the filter.

searchFilterName

string

CloudBees Flow-generated name composed from displayName, objectType operation argument values and userName who invoked the operation, using the following algorithm:

  • userName , displayName, objectType values are joined using '_' separator, or example admin_filter_pipeline.

  • If resulting string length is greater then 255 symbols, then the result string is truncated to 200 symbols and timestamp is added, for example, ` admin_thisnameissolongitdoesntfitinto255symbolslimit_20180905142500`.

searchQuery

string

CLOB field to store the findObjects search query.

serverState

enum

Possible values are: bootstrap, databaseConfiguration, databaseConnection, databaseSchema, running, failed, stopping, importFailed

severity

enum

Possible values are: INFO|WARN|ERROR

shared

boolean

Flag to denote public (true) or private (false) filter.

shell

string

Where shell is the name of a program used to execute commands contained in the “command” field. Normally, this file is a command shell, but it could be any other command line program. The default is "cmd /q /c" for a Windows agent and "sh -e" for a UNIX agent. This is applicable to command steps only.

signature

string

The digital signature on this license.

start

date

The time this job or workflow began executing.

startable

boolean

"True" means this state definition can be the initial state of an instantiated workflow.

startingState

string

The initial state of the workflow.

startTime

string

Formatted hh:mm, using the 24-hour clock. Using this schedule, CloudBees Flow starts creating jobs at this time on the specified days.

stateDefinitionId

number

The unique CloudBees Flow-generated ID for this state definition object.

stateDefinitionName

string

The name of the state definition.

stateId

number

The unique CloudBees Flow-generated ID for this state object.

statementCacheSize

string

The number of MS SQL statements cached in the database.

stateName

string

The name of the state.

status

enum

Possible values for status : pending —The job is not yet runnable—it is waiting for other steps to complete first. runnable —The job is ready to run, but it is waiting for a resource to become available. running —The job is assigned to a resource and is executing the step command. completed —The job finished executing.

stepCount

number

The number of executing steps on this resource.

stepErrorCode

enum

Agent error messages.

stepId

number

The unique CloudBees Flow-generated ID for the step.

stepLimit

number

The number of steps that can run on the resource at one time. (Previously setting the limit to 1 enforces serial access to the resource.)

stepName

string

The name of the step—may be a path to the step.

steps

The list or number of steps in a job.

stopTime

string

Formatted hh:mm, using the 24-hour clock. CloudBees Flow stops creating new jobs at this time, but a job in progress will continue to run. If stopTime is not specified, CloudBees Flow creates one job only on each specified day.

subject

string

Refers to the object the event concerns (similar to container ).

subjectName

string

The name of the subject/object.

subjob

string

The name of the subjob.

subprocedure

string

The name of the nested procedure called when a step runs. If a subprocedure is specified, command or commandFile options are not necessary.

subproject

string

If a subprocedure argument was used, this is the name of the project where that subprocedure is found. By default, the current project is used.

substartingState

sting

Name of the starting state for the workflow launched when the state is entered.

subworkflow

string

The name of the subworkflow.

subworkflowDefinition

string

The name of the subworkflow definition.

targetState

string

The target state for the transition definition.

testResult

enum

Possible values are: success|skipped|failure

time

date

The time of day to invoke this schedule’s procedure (24-hour clock, for example, 17:00). For a logEntry response, time indicates the time at which data was written to the log.

timeLimit

number

The maximum length of time the step is allowed to run. After the time specified, the step will be aborted. The time limit is specified in units that can be hours, minutes, or seconds.

timeLimitUnits

enum

Possible values are: hours|minutes|seconds

timeout

number

Specifies the timeout for the element flag. The default value is 120 seconds.

timeZone

string

The time zone specified to use for this schedule (Java-compatible string).

totalCallCount

number

The total number of API calls to the server since startup.

totalWaitTime

On a job, this is the sum of total time all job steps waited for license, resource, and/or workspace availability.

transitionDefinitionId

number

The unique CloudBees Flow-generated ID for this transition definition.

transitionDefinitionName

string

The name of the transition definition.

transitionId

number

The unique CloudBees Flow-generated ID for this transition object.

transitionName

string

The name of the transition.

trigger

enum

Possible values are: onEnter|onStart|onCompletion|manual

trusted

boolean

< Boolean flag— 0|1|true|false > If "true", the resource is trusted . A trusted agent is one that has been "certificate verified." Agents can be either trusted or untrusted :

  • trusted—the CloudBees Flow server verifies the agent’s identity using SSL certificate verification.

  • untrusted—the CloudBees Flow server does not verify agent identity. Potentially, an untrusted agent is a security risk.

type

string

The "type" is any string value. Used primarily by the web interface to represent custom form elements. However, if "credential" is the string value, the server will expect a credential as the parameter value.

url

string

For directory providers: The server URL is in the form protocol://host:port/basedn. Protocol is either ldap or ldaps (for secure LDAP). The port is implied by the protocol, but can be overridden if it is not at the default location (389 for ldap, 636 for ldaps). The basedn is the path to the top-level directory that contains users and groups at this site. This is typically the domain name where each part is listed with a dc= and separated by commas.

Spaces in the basedn must be URL encoded (%20).

For artifact repositories: The server URL is in the form protocol://host:port/. Typically, the repository server is configured to listen on port 8200 for https requests, so a typical URL looks like https://host:8200/.

userAuthenticationTest

subcontainer

For the testDirectoryProvider API, this element authenticates the user.

userBase

string

The string prepended to the basedn to construct the directory DN that contains user records.

userId

number

The unique CloudBees Flow-generated ID for the user.

userInfo

findUserTest container element includes a userList subcontainer that may include multiple userInfo tags, each of which describes a user (including full name, email address, and provider name).

userList

list

findUserTest container element includes a userList subcontainer that may include one or more userInfo tags.

userName

string

The full name of the user. For Active Directory and LDAP, the name may be user@domain.

userNameAttribute

string

The attribute in a user record that contains the user’s account name.

userSearchFilter

string

The LDAP query performed in the context of the user directory to search for a user by account name. The string "{0}" is replaced with the user’s login ID. Typically, the query compares a user record attribute with the substituted user login ID.

userSearchSubtree

boolean

< Boolean flag — 0|1|true|false > If true, the subtree below the user base was recursively searched.

userSettingsId

number

The unique CloudBees Flow-generated ID for the user settings.

useSSL

boolean

< Boolean flag — 0|1|true|false > This flag is used to specify using SSL to communicate with your Active Directory servers.

Transport Layer Security (TLS) has replaced Secure Sockets Layer version 3.0 (SSLv3) on the CloudBees Flow web server and the CloudBees Flow server.

value

string

For a string property, this is the value of the property. For a sheet property, this argument is invalid.

version

string

For plugin versions, the value is represented in the form: major.minor. For artifact versions, the value is represented in the form: major.minor.patch-qualifier-buildNumber

waitReason

string

Possible values are: license, resource, or workspace Generally, this objects are unavailable, causing a longer wait time for availability.

waitTime

number

The number of milliseconds the step spent between runnable and running (for example, waiting for a resource).

weekDays

string

Restricts the schedule to specified days of the week. Days of the week are separated by spaces. English names "Monday", "Tuesday", and so on.

workflowDefinitionId

number

The unique CloudBees Flow-generated ID for this workflow definition.

workflowDefinitionName

string

The name of the workflow definition.

workflowId

number

The unique CloudBees Flow-generated ID for this workflow object.

workflowName

string

The name of this workflow.

workflowNameTemplate

string

Template used to determine the default names for workflows launched from a workflow definition.

workingDirectory

string

The CloudBees Flow agent sets this directory as the “current working directory,” when running the command contained in the step. If no working directory is specified in the step, CloudBees Flow uses the directory it created for the job in the CloudBees Flow workspace as the working directory.

If running a step on a proxy resource, this directory must exist on the proxy target.

workspaceDisabled

boolean

< Boolean flag — 0|1|true|false >— If "true," the workspace is disabled.

workspaceId

number

The unique CloudBees Flow-generated ID for the workspace.

workspaceName

string

The name of the workspace.

workspaceWaitTime

The total time a job step waited for workspace availability. On a job, this is the sum of time all job steps waited for workspace availability.

zoneId

number

The CloudBees Flow-generated ID for this zone.

zoneName

string

The name of the zone.