findProperties

Back to index

Summary

Return properties of a particular object.

applicationName

Stringoptional

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

applicationTierName

Stringoptional

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

archiveConnectorName

Stringoptional

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

artifactName

Stringoptional

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

artifactVersionName

Stringoptional

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

catalogItemRunId

Stringoptional

The primary key of the CatalogItemRun container of the property sheet that owns the property.

catalogName

Stringoptional

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

ciBuildDetailName

Stringoptional

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

clusterName

Stringoptional

The name of the cluster which owns property sheet.

componentName

Stringoptional

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

configName

Stringoptional

The name of the emailConfig container that owns the property.

credentialName

Stringoptional

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

dashboardName

Stringoptional

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

dataRetentionPolicyName

Stringoptional

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

environmentName

Stringoptional

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

environmentTemplateName

Stringoptional

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

environmentTemplateTierName

Stringoptional

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

environmentTierName

Stringoptional

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

filters

Array<Filter>optional

A list of zero or more filter criteria definitions used to define objects to find.

flowName

Stringoptional

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

flowRuntimeId

Stringoptional

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

flowRuntimeName

Stringoptional

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

flowRuntimeStateId

Stringoptional

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

flowRuntimeStateName

Stringoptional

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

flowStateName

Stringoptional

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

flowTransitionName

Stringoptional

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

gateType

Stringoptional

The type of the gate which owns property sheet.

Possible values: "POST", "PRE"

gatewayName

Stringoptional

The name of the gateway container of the property sheet.

groupName

Stringoptional

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

jobId

Stringoptional

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

jobStepId

Stringoptional

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

maxIds

Integeroptional

The maximum number of object IDs to return.

microserviceName

Stringoptional

The name of the microservice container of the property sheet.

notifierName

Stringoptional

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

numObjects

Integeroptional

The number of objects to return as the first page of results.

objectId

Stringoptional

The object ID as returned by FindObjects.

path

Stringoptional

Property path string.

pipelineName

Stringoptional

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

pluginConfigurationName

Stringoptional

The name of the plugin configuration container of the property sheet that owns the property.

pluginName

Stringoptional

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

procedureName

Stringoptional

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

processName

Stringoptional

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

processStepName

Stringoptional

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

projectName

Stringoptional

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

propertySheetId

Stringoptional

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

releaseName

Stringoptional

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

reportName

Stringoptional

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

reportObjectTypeName

Stringoptional

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

repositoryName

Stringoptional

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

resourceName

Stringoptional

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

resourcePoolName

Stringoptional

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

resourceTemplateName

Stringoptional

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

scheduleName

Stringoptional

The name of the schedule container of the property sheet.

scmSyncName

Stringoptional

The name of the SCM Sync container of the property sheet that owns the property.

searchFilterName

Stringoptional

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

serviceAccountName

Stringoptional

Retrieves the name of the service account container of the property sheet.

snapshotName

Stringoptional

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

sorts

Array<Sort>optional

Sort specifications.

stageName

Stringoptional

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

stateDefinitionName

Stringoptional

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

stateName

Stringoptional

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

stepName

Stringoptional

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

systemObjectName

Stringoptional

The system object.

Possible values: "admin", "analyticsServerConfigurations", "archiveConnectors", "artifacts", "ciConfigurations", "ciEventsSchemaConfiguration", "ciJobDetails", "ciLoginHistory", "complianceConfiguration", "dataRetentionPolicies", "devOpsForesight", "devOpsInsightServerConfigurations", "directory", "dslClientFiles", "emailConfigs", "forceAbort", "licensing", "log", "personaCategories", "personaPages", "personas", "plugins", "priority", "projects", "reportObjectTypes", "repositories", "resources", "searchFilters", "server", "session", "ssoConfiguration", "ssoLoginHistory", "statsdConfiguration", "tags", "workspaces", "zonesAndGateways"

taskName

Stringoptional

The name of the task which owns property sheet.

transitionDefinitionName

Stringoptional

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

transitionName

Stringoptional

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

triggerName

Stringoptional

The name of the trigger which owns property sheet.

userName

Stringoptional

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

widgetName

Stringoptional

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

workflowDefinitionName

Stringoptional

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

workflowName

Stringoptional

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

workspaceName

Stringoptional

The name of the workspace container of the property sheet.

zoneName

Stringoptional

The name of the zone container of the property sheet.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.findProperties(
  /* optional arguments */
)▼