1. REST API for Oracle Visual Builder Studio
  2. Tasks
  3. Builds
  4. Pipelines

Get pipeline instances

get

/v1/pipelines/{pipelineName}/instances

Returns a list of instances for a pipeline

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Returns a list of URIs with pipeline names and instance ids, such as pipelines/Example/instances/344, followed by date and time, one instance per line

404 Response

ERROR: No such pipeline {pipelineName}
Back to Top

Examples

Two examples are shown. Both return a list of pipeline instances in the format @pipelines/{pipelineName}/instances/{instanceNumber} and timestamps, one per line. Pipeline instances are returned in descending order, with the most recent instance listed first.

You can use the optional zone query parameter to specify the timezone in which the times are displayed. By default, the timezone is the server timezone, usually GMT.

Note:

The timestamp shown in the VB Studio UI is the timezone that is set in the browser. It may be different than the server timezone returned by the REST API.

The first example shows how to get a list of pipeline instances and timestamps in GMT (the default timezone when the zone parameter query isn't used) for pipeline AutoTest by submitting a GET request on the REST resource using curl. 

curl -X GET -u alex.admin https://myinstance.oracle.com/myorg/rest/myorg_bobtest_1/cibuild/v1/pipelines/AutoTest/instances
Enter host password for user 'alex.admin':
pipelines/AutoTest/instances/261 [Feb 12, 2020 10:08 PM GMT]
pipelines/AutoTest/instances/241 [Feb 04, 2020 04:05 AM GMT]
pipelines/AutoTest/instances/222 [Jan 27, 2020 10:42 PM GMT]
pipelines/AutoTest/instances/221 [Jan 27, 2020 07:21 PM GMT]
pipelines/AutoTest/instances/200 [Jan 24, 2020 01:06 AM GMT]
pipelines/AutoTest/instances/198 [Jan 24, 2020 12:44 AM GMT]
pipelines/AutoTest/instances/196 [Jan 24, 2020 12:40 AM GMT]
pipelines/AutoTest/instances/194 [Jan 24, 2020 12:40 AM GMT]
pipelines/AutoTest/instances/192 [Jan 24, 2020 12:37 AM GMT]
pipelines/AutoTest/instances/190 [Jan 24, 2020 12:10 AM GMT]
pipelines/AutoTest/instances/188 [Jan 24, 2020 12:04 AM GMT]
pipelines/AutoTest/instances/187 [Jan 22, 2020 11:25 PM GMT]
pipelines/AutoTest/instances/186 [Jan 21, 2020 11:05 PM GMT]
pipelines/AutoTest/instances/185 [Jan 21, 2020 10:54 PM GMT]
pipelines/AutoTest/instances/184 [Jan 21, 2020 10:52 PM GMT]

The second example shows how to get a list of pipeline instances and timestamps in PST (by setting the optional zone query parameter to PST) for pipeline AutoTest by submitting a GET request on the REST resource. 

curl -X GET -u alex.admin https://myinstance.oracle.com/myorg/rest/myorg_bobtest_1/cibuild/v1/pipelines/AutoTest/instances?zone=PST
Enter host password for user 'alex.admin':
pipelines/AutoTest/instances/261 [Feb 12, 2020 02:08 PM PST]
pipelines/AutoTest/instances/241 [Feb 03, 2020 08:05 PM PST]
pipelines/AutoTest/instances/222 [Jan 27, 2020 02:42 PM PST]
pipelines/AutoTest/instances/221 [Jan 27, 2020 11:21 AM PST]
pipelines/AutoTest/instances/200 [Jan 23, 2020 05:06 PM PST]
pipelines/AutoTest/instances/198 [Jan 23, 2020 04:44 PM PST]
pipelines/AutoTest/instances/196 [Jan 23, 2020 04:40 PM PST]
pipelines/AutoTest/instances/194 [Jan 23, 2020 04:40 PM PST]
pipelines/AutoTest/instances/192 [Jan 23, 2020 04:37 PM PST]
pipelines/AutoTest/instances/190 [Jan 23, 2020 04:10 PM PST]
pipelines/AutoTest/instances/188 [Jan 23, 2020 04:04 PM PST]
pipelines/AutoTest/instances/187 [Jan 22, 2020 03:25 PM PST]
pipelines/AutoTest/instances/186 [Jan 21, 2020 03:05 PM PST]
pipelines/AutoTest/instances/185 [Jan 21, 2020 02:54 PM PST]
pipelines/AutoTest/instances/184 [Jan 21, 2020 02:52 PM PST]

Errors

If you searched for the pipeline instances but the pipeline couldn't be found, you'll see this error:

ERROR: No such pipeline {pipelineName}
Back to Top