Custom filter

1 minute readReference

createSearchFilter

Creates a new custom filter for the currently logged in user.

Arguments

Argument Name Type Description

displayName

String

(Required) Search filter name.

objectType

String

(Required) Object type.

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.

Positional arguments

displayName, objectType

Usage

ec-perl

$cmdr->createSearchFilter(<displayName>, <objectType>, {<optionals>});

ectool

ectool createSearchFilter displayName objectType [optionals]

deleteSearchFilter

Deletes a search filter.

Arguments

Argument Name Type Description

displayName

String

(Required) Search filter name.

objectType

String

(Required) Object type.

userName

String

Search filter user name.

Positional arguments

displayName, objectType

Usage

ec-perl

$cmdr->deleteSearchFilter(<displayName>, <objectType>, {<optionals>});

ectool

ectool deleteSearchFilter displayName objectType [optionals]

getSearchFilter

Retrieves a search filter by name.

Arguments

Argument Name Type Description

displayName

String

(Required) Search filter name.

objectType

String

(Required) Object type.

userName

String

Search filter user name.

Positional arguments

displayName, objectType

Usage

ec-perl

$cmdr->getSearchFilter(<displayName>, <objectType>, {<optionals>});

ectool

ectool getSearchFilter displayName objectType [optionals]

getSearchFilters

Retrieves all search filters.

Arguments

Argument Name Type Description

objectType

String

Object type.

userName

String

Search filter user name.

Positional arguments

None.

Usage

ec-perl

$cmdr->getSearchFilters({<optionals>});

ectool

ectool getSearchFilters [optionals]

modifySearchFilter

Modifies an existing search filter.

Arguments

Argument Name Type Description

displayName

String

(Required) Search filter name.

objectType

String

(Required) Object type.

description

String

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

newName

String

The 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.

Positional arguments

displayName, objectType

Usage

ec-perl

$cmdr->modifySearchFilter(<displayName>, <objectType>, {<optionals>});

ectool

ectool modifySearchFilter displayName objectType [optionals]