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

CI job

1 minute readReference

getCIJob

Retrieves the specified CI job.

Arguments

Argument Name Type Description

ciConfigurationName

String

(Required) The CI configuration name.

ciControllerDomain

String

The domain name of the CI controller.

ciEndpoint

String

Endpoint of the CI Controller.

ciJobName

String

The CI job name.

folder

String

The path to the folder on the CI server referenced by the CI configuration that contains the CI jobs. The folder path must be in format of: folder1/folder2/folder3/…​

Positional arguments

ciConfigurationName

Usage

ec-perl

$cmdr->getCIJob(<ciConfigurationName>, {<optionals>});
▼

ectool

ectool getCIJob ciConfigurationName, [optionals]
▼

getCIJobParameters

Retrieves parameters for the given CI job.

Arguments

Argument Name Type Description

ciConfigurationName

String

(Required) The CI configuration name.

ciJobName

String

(Required) Name of the CI job.

ciControllerDomain

String

The domain name of the CI controller.

ciEndpoint

String

Endpoint of the CI Controller.

ciJobBranchName

String

Name of the CI Job Branch.

folder

String

The path to the folder on the CI server referenced by the CI configuration that contains the CI jobs. The folder path must be in format of: folder1/folder2/folder3/…​

Positional arguments

ciConfigurationName, ciJobName

Usage

ec-perl

$cmdr->getCIJobParameters(<ciConfigurationName>, <ciJobName>, {<optionals>});
▼

ectool

ectool getCIJobParameters ciConfigurationName,  ciJobName, [optionals]
▼

getCIJobs

Retrieves CI jobs for the specified CI configuration.

Arguments

Argument Name Type Description

ciConfigurationName

String

(Required) The CI configuration name.

ciControllerDomain

String

The domain name of the CI controller.

ciEndpoint

String

Endpoint of the CI Controller.

folder

String

The path to the folder on the CI server referenced by the CI configuration that contains the CI jobs. The folder path must be in format of: folder1/folder2/folder3/…​

jobSearchType

CIJobSearchType

Specify job search type: FOLDER to return all folders and ciControllers, JOB (default) to return all other job types, or ALL to return both jobs and folders

Positional arguments

ciConfigurationName

Usage

ec-perl

$cmdr->getCIJobs(<ciConfigurationName>, {<optionals>});
▼

ectool

ectool getCIJobs ciConfigurationName, [optionals]
▼
CI event
Cluster