Using the Perl API
Perl API response and element glossary
IntroductionACL managementApplication dependencyApplicationsApplication tierArtifact managementCatalogsChange historyCI Build detailCI configurationCI JobsComponentsCredential managementCustom filtersDatabase configurationData retentionDevOps insightDirectory Provider managementDynamic environmentsemail configuration managementEmail Notifier managementEnvironmentEnvironment tierGateway and Zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and Group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationclustercomponentcontainercredentialdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitionuserutilityresourcewaitdependencywidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezone

AclEntry

17 minute readReference

createAclEntry

Create an ACE on an object for a given principal.

Arguments

Argument Name Type Description

principalName

String

Name of the user or group for this access control entry. (Required)

principalType

String

Type of principal for this access control entry (user or group). (Required)

applicationName

String

The name of the application container of the property sheet which owns the property.

applicationTierName

String

The name of the application tier container of the property sheet which owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet which owns the property.

artifactName

String

The name of the artifact container of the property sheet which owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet which owns the property.

catalogName

String

The name of the catalog of the property sheet which owns the property.

changePermissionsPrivilege

String

Determines whether the principal can modify access control for the object.

ciBuildDetailName

String

The name of the CI build detail of the property sheet which owns the property.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet which owns the property.

configName

String

The name of the emailConfig container that owns the property.

containerName

String

The name of the container that owns the property.

credentialName

String

The name of the credential container of the property sheet which owns the property.

dashboardName

String

The name of the dashboard of the property sheet which owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet which owns the property.

environmentName

String

The name of the environment container of the property sheet which owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet which owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet which owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet which owns the property.

executePrivilege

String

Determines whether the principal can invoke this object as part of a job; this privilege is only relevant for a few objects such as procedures and procedure steps.

flowName

String

The name of the flow container of the property sheet which owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet which owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet which owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet which owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet which owns the property.

flowStateName

String

The name of the flow state container of the property sheet which owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet which owns the property.

gateType

String

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet which owns the property.

jobId

String

The primary key or name of the job container of the property sheet which owns the property.

jobStepId

String

The primary key of the job-step container of the property sheet which owns the property.

kerberosKeytabName

String

The name of the kerberos keytab.

modifyPrivilege

String

Determines whether the principal can change the contents of the object.

notifierName

String

The name of the notifier container of the property sheet which owns the property.

objectId

String

The object id as returned by FindObjects.

objectType

String

The type of object protected by the access control

path

String

Property path string.

personaName

String

The name of the persona.

pipelineName

String

The name of the pipeline container of the property sheet which owns the property.

pluginName

String

The name of the plugin container of the property sheet which owns the property.

procedureName

String

The name of the procedure container of the property sheet which owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet which owns the property.

propertySheetId

String

The primary key of the property sheet which owns the property.

readPrivilege

String

Determines whether the principal can examine the contents of the object

releaseName

String

The name of the release container of the property sheet which owns the property.

reportName

String

The name of the report of the property sheet which owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet which owns the property.

repositoryName

String

The name of the repository container of the property sheet which owns the property.

resourceName

String

The name of the resource container of the property sheet which owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet which owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet which owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

searchFilterName

String

The name of the search filter container of the property sheet.

serviceAccountName

String

Get the name of the service account container of the property sheet

serviceName

String

The name of the service container of the property sheet.

snapshotName

String

The name of the snapshot container of the property sheet which owns the property.

stageName

String

The name of the stage container of the property sheet which owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet which owns the property.

stateName

String

The name of the state container of the property sheet which owns the property.

stepName

String

The name of the step container of the property sheet which owns the property.

systemObjectName

String

The system object.

tagName

String

The name of the tag.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of the transition definition container of the property sheet which owns the property.

transitionName

String

The name of the transition container of the property sheet which owns the property.

userName

String

The name of the user container of the property sheet which owns the property.

widgetName

String

The name of the widget of the property sheet which owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet which owns the property.

workflowName

String

The name of the workflow container of the property sheet which owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createAclEntry(
                principalName: 'test-principalName',
                principalType: 'test-principalType'
                /* optional arguments */)

deleteAclEntry

Delete an ACE on an object for a given principal.

Arguments

Argument Name Type Description

principalName

String

Name of the user or group for this access control entry. (Required)

principalType

String

Type of principal for this access control entry (user or group). (Required)

applicationName

String

The name of the application container of the property sheet which owns the property.

applicationTierName

String

The name of the application tier container of the property sheet which owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet which owns the property.

artifactName

String

The name of the artifact container of the property sheet which owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet which owns the property.

catalogName

String

The name of the catalog of the property sheet which owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet which owns the property.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet which owns the property.

configName

String

The name of the emailConfig container that owns the property.

containerName

String

The name of the container that owns the property.

credentialName

String

The name of the credential container of the property sheet which owns the property.

dashboardName

String

The name of the dashboard of the property sheet which owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet which owns the property.

environmentName

String

The name of the environment container of the property sheet which owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet which owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet which owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet which owns the property.

flowName

String

The name of the flow container of the property sheet which owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet which owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet which owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet which owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet which owns the property.

flowStateName

String

The name of the flow state container of the property sheet which owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet which owns the property.

gateType

String

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet which owns the property.

jobId

String

The primary key or name of the job container of the property sheet which owns the property.

jobStepId

String

The primary key of the job-step container of the property sheet which owns the property.

kerberosKeytabName

String

The name of the kerberos keytab.

notifierName

String

The name of the notifier container of the property sheet which owns the property.

objectId

String

The object id as returned by FindObjects.

objectType

String

The type of object protected by the access control

path

String

Property path string.

personaName

String

The name of the persona.

pipelineName

String

The name of the pipeline container of the property sheet which owns the property.

pluginName

String

The name of the plugin container of the property sheet which owns the property.

procedureName

String

The name of the procedure container of the property sheet which owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet which owns the property.

propertySheetId

String

The primary key of the property sheet which owns the property.

releaseName

String

The name of the release container of the property sheet which owns the property.

reportName

String

The name of the report of the property sheet which owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet which owns the property.

repositoryName

String

The name of the repository container of the property sheet which owns the property.

resourceName

String

The name of the resource container of the property sheet which owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet which owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet which owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

searchFilterName

String

The name of the search filter container of the property sheet.

serviceAccountName

String

Get the name of the service account container of the property sheet

serviceName

String

The name of the service container of the property sheet.

snapshotName

String

The name of the snapshot container of the property sheet which owns the property.

stageName

String

The name of the stage container of the property sheet which owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet which owns the property.

stateName

String

The name of the state container of the property sheet which owns the property.

stepName

String

The name of the step container of the property sheet which owns the property.

systemObjectName

String

The system object.

tagName

String

The name of the tag.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of the transition definition container of the property sheet which owns the property.

transitionName

String

The name of the transition container of the property sheet which owns the property.

userName

String

The name of the user container of the property sheet which owns the property.

widgetName

String

The name of the widget of the property sheet which owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet which owns the property.

workflowName

String

The name of the workflow container of the property sheet which owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteAclEntry(
                principalName: 'test-principalName',
                principalType: 'test-principalType'
                /* optional arguments */)

getAclEntry

Get an ACE on an object for a given principal.

Arguments

Argument Name Type Description

principalName

String

Name of the user or group for this access control entry. (Required)

principalType

String

Type of principal for this access control entry (user or group). (Required)

applicationName

String

The name of the application container of the property sheet which owns the property.

applicationTierName

String

The name of the application tier container of the property sheet which owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet which owns the property.

artifactName

String

The name of the artifact container of the property sheet which owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet which owns the property.

catalogName

String

The name of the catalog of the property sheet which owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet which owns the property.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet which owns the property.

configName

String

The name of the emailConfig container that owns the property.

containerName

String

The name of the container that owns the property.

credentialName

String

The name of the credential container of the property sheet which owns the property.

dashboardName

String

The name of the dashboard of the property sheet which owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet which owns the property.

environmentName

String

The name of the environment container of the property sheet which owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet which owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet which owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet which owns the property.

flowName

String

The name of the flow container of the property sheet which owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet which owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet which owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet which owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet which owns the property.

flowStateName

String

The name of the flow state container of the property sheet which owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet which owns the property.

gateType

String

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet which owns the property.

jobId

String

The primary key or name of the job container of the property sheet which owns the property.

jobStepId

String

The primary key of the job-step container of the property sheet which owns the property.

kerberosKeytabName

String

The name of the kerberos keytab.

notifierName

String

The name of the notifier container of the property sheet which owns the property.

objectId

String

The object id as returned by FindObjects.

objectType

String

The type of object protected by the access control

path

String

Property path string.

personaName

String

The name of the persona.

pipelineName

String

The name of the pipeline container of the property sheet which owns the property.

pluginName

String

The name of the plugin container of the property sheet which owns the property.

procedureName

String

The name of the procedure container of the property sheet which owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet which owns the property.

propertySheetId

String

The primary key of the property sheet which owns the property.

releaseName

String

The name of the release container of the property sheet which owns the property.

reportName

String

The name of the report of the property sheet which owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet which owns the property.

repositoryName

String

The name of the repository container of the property sheet which owns the property.

resourceName

String

The name of the resource container of the property sheet which owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet which owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet which owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

searchFilterName

String

The name of the search filter container of the property sheet.

serviceAccountName

String

Get the name of the service account container of the property sheet

serviceName

String

The name of the service container of the property sheet.

snapshotName

String

The name of the snapshot container of the property sheet which owns the property.

stageName

String

The name of the stage container of the property sheet which owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet which owns the property.

stateName

String

The name of the state container of the property sheet which owns the property.

stepName

String

The name of the step container of the property sheet which owns the property.

systemObjectName

String

The system object.

tagName

String

The name of the tag.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of the transition definition container of the property sheet which owns the property.

transitionName

String

The name of the transition container of the property sheet which owns the property.

userName

String

The name of the user container of the property sheet which owns the property.

widgetName

String

The name of the widget of the property sheet which owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet which owns the property.

workflowName

String

The name of the workflow container of the property sheet which owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getAclEntry(
                principalName: 'test-principalName',
                principalType: 'test-principalType'
                /* optional arguments */)

modifyAclEntry

Modify an ACE on an object for a given principal.

Arguments

Argument Name Type Description

principalName

String

Name of the user or group for this access control entry. (Required)

principalType

String

Type of principal for this access control entry (user or group). (Required)

applicationName

String

The name of the application container of the property sheet which owns the property.

applicationTierName

String

The name of the application tier container of the property sheet which owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet which owns the property.

artifactName

String

The name of the artifact container of the property sheet which owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet which owns the property.

catalogName

String

The name of the catalog of the property sheet which owns the property.

changePermissionsPrivilege

String

Determines whether the principal can modify access control for the object.

ciBuildDetailName

String

The name of the CI build detail of the property sheet which owns the property.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet which owns the property.

configName

String

The name of the emailConfig container that owns the property.

containerName

String

The name of the container that owns the property.

credentialName

String

The name of the credential container of the property sheet which owns the property.

dashboardName

String

The name of the dashboard of the property sheet which owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet which owns the property.

environmentName

String

The name of the environment container of the property sheet which owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet which owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet which owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet which owns the property.

executePrivilege

String

Determines whether the principal can invoke this object as part of a job; this privilege is only relevant for a few objects such as procedures and procedure steps.

flowName

String

The name of the flow container of the property sheet which owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet which owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet which owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet which owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet which owns the property.

flowStateName

String

The name of the flow state container of the property sheet which owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet which owns the property.

gateType

String

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet which owns the property.

jobId

String

The primary key or name of the job container of the property sheet which owns the property.

jobStepId

String

The primary key of the job-step container of the property sheet which owns the property.

kerberosKeytabName

String

The name of the kerberos keytab.

modifyPrivilege

String

Determines whether the principal can change the contents of the object.

notifierName

String

The name of the notifier container of the property sheet which owns the property.

objectId

String

The object id as returned by FindObjects.

objectType

String

The type of object protected by the access control

path

String

Property path string.

personaName

String

The name of the persona.

pipelineName

String

The name of the pipeline container of the property sheet which owns the property.

pluginName

String

The name of the plugin container of the property sheet which owns the property.

procedureName

String

The name of the procedure container of the property sheet which owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet which owns the property.

propertySheetId

String

The primary key of the property sheet which owns the property.

readPrivilege

String

Determines whether the principal can examine the contents of the object

releaseName

String

The name of the release container of the property sheet which owns the property.

reportName

String

The name of the report of the property sheet which owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet which owns the property.

repositoryName

String

The name of the repository container of the property sheet which owns the property.

resourceName

String

The name of the resource container of the property sheet which owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet which owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet which owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

searchFilterName

String

The name of the search filter container of the property sheet.

serviceAccountName

String

Get the name of the service account container of the property sheet

serviceName

String

The name of the service container of the property sheet.

snapshotName

String

The name of the snapshot container of the property sheet which owns the property.

stageName

String

The name of the stage container of the property sheet which owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet which owns the property.

stateName

String

The name of the state container of the property sheet which owns the property.

stepName

String

The name of the step container of the property sheet which owns the property.

systemObjectName

String

The system object.

tagName

String

The name of the tag.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of the transition definition container of the property sheet which owns the property.

transitionName

String

The name of the transition container of the property sheet which owns the property.

userName

String

The name of the user container of the property sheet which owns the property.

widgetName

String

The name of the widget of the property sheet which owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet which owns the property.

workflowName

String

The name of the workflow container of the property sheet which owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyAclEntry(
                principalName: 'test-principalName',
                principalType: 'test-principalType'
                /* optional arguments */)
acl
actualparameter