findJobSteps

Back to index

Summary

Retrieves a list of job steps from a single job or from a single subprocedure job step. This command is used by the Job Details web page in the CloudBees CD/RO UI. The elements in the list are returned in their natural job order.

This API is not supported by ectool.

For a list of object types in CloudBees CD/RO, refer to Object types in CloudBees CD/RO.
filter
Arrayoptional
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.
jobId
Stringoptional
The primary key of the job, or the name of the job.
jobStepId
UUIDoptional
The primary key for a job step.
maxIds
Integeroptional
The maximum number of object IDs to return.
numObjects
Integeroptional
The number of objects to return as the first page of results.
select
Arrayoptional
Custom properties to project into the query results.

Usage

Perl

$cmdr->findJobSteps( # optionals );

ectool

ectool findJobSteps \ # optionals

Examples

Perl

Example 1

my $xPath = $cmdr->findJobSteps( {jobId => "4fa765dd-73f1-11e3-b67e-b0a420524153", select => [{propertyName => 'charEncoding'}, {propertyName => 'abc'}]}); print "Return data from CloudBees CD/RO :\n" . $xPath-> findnodes_as_string("/"). "\n";

Example 2

my $xPath = $cmdr->findJobSteps({jobStepId => "5da765dd-73f1-11e3-b67e-b0a420524153"}); print "Return data from CloudBees CD/RO :\n" . $xPath-> findnodes_as_string("/"). "\n";

ectool

This API is not supported by ectool.