Introduction
Using JRuby
API error messages
API command line access
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory 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
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

SearchFilter

2 minute readReference

createSearchFilter

Create a search filter.

Arguments

Argument NameTypeDescription

objectType

String

Object type. (Required)

displayName

String

Search filter name. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

searchQuery

String

Search filter query CLOB

shared

Boolean

Flag indicating whether the filter is public or private

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createSearchFilter(
                objectType: 'test-objectType',
                displayName: 'test-displayName'
                /* optional arguments */)

deleteSearchFilter

Delete a search filter from the database.

Arguments

Argument NameTypeDescription

objectType

String

Object type. (Required)

displayName

String

Search filter name. (Required)

userName

String

Search filter user name

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteSearchFilter(
                objectType: 'test-objectType',
                displayName: 'test-displayName'
                /* optional arguments */)

getSearchFilter

Returns search filter.

Arguments

Argument NameTypeDescription

objectType

String

Object type. (Required)

displayName

String

Search filter name. (Required)

userName

String

Search filter user name

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSearchFilter(
                objectType: 'test-objectType',
                displayName: 'test-displayName'
                /* optional arguments */)

getSearchFilters

Retrieve all search filter names.

Arguments

Argument NameTypeDescription

objectType

String

Object type.

userName

String

Search filter user name

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSearchFilters(
                /* optional arguments */)

modifySearchFilter

Modify a search filter.

Arguments

Argument NameTypeDescription

objectType

String

Object type. (Required)

displayName

String

Search filter name. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

String

New name for an existing object that is being renamed.

newObjectType

String

Search filter entity type

searchQuery

String

Search filter query CLOB

shared

Boolean

Flag indicating whether the filter is public or private

userName

String

Search filter user name

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifySearchFilter(
                objectType: 'test-objectType',
                displayName: 'test-displayName'
                /* optional arguments */)
schedule
server