Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

findObjects

On this page
Back to index

Summary

This command returns a sorted list of CloudBees CD/RO objects based on an object type and a set of filter criteria. This API can be used to find many, but not all, types of CloudBees CD/RO objects and is used by the CloudBees CD/RO web interface to implement the CloudBees CD/RO Search feature.
objectType
Stringrequired
The object type to search for.
filters
Stringoptional
A list of zero or more filter criteria definitions used to define objects to find.
firstResult
Integeroptional
The first result to be retrieved, numbered from 0.
includeAccess
Booleanoptional
True to fetch the objects' access maps as well.
includeEntityRevisions
Booleanoptional
Include versions/entity revision if it is a revisionable object in the search result.
includeLatestRevision
Booleanoptional
Include the latest revision data for versioned objects.
maxIds
Integeroptional
The maximum number of object IDs to return.
numObjects
Integeroptional
The number of objects to return as the first page of results.
quickSearchFilter
Stringoptional
Quick search filter.
selects
Stringoptional
Custom properties to project into the query results.
sorts
Stringoptional
Sort specifications.
viewName
Stringoptional
The name of the view.

Usage

Perl

$cmdr->findObjects(
  "test-objectType" # objectType
  # optionals
);
▼

ectool

ectool findObjects \
  "test-objectType" `# objectType` \
  # optionals
▼