Get parameter definitions for jobs in the pipeline
get
/v1/pipelines/{pipelineName}/params
Returns the parameter definitions in YAML format
Request
Path Parameters
-
pipelineName: string
pipeline name
Response
Supported Media Types
- text/plain
200 Response
{parameterDefinitions}
400 Response
ERROR: {message}
401 Response
ERROR: Not authorized
403 Response
ERROR: Error processing {request}
404 Response
ERROR: No such pipeline {pipelineName}
Examples
The following example shows how to retrieve the parameters defined for jobs in the pipeline (ParamPipeline), in YAML format 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/ParamPipeline/params
Enter host password for user 'alex.admin':
params:
# Pipeline ParamPipeline
# Job A defines no parameters
# Job Params parameters:
- password:
secret="********"
- choices="a"
- GIT_REPO_URL="https://"
- GIT_REPO_BRANCH="mybranch"
- MERGE_REQ_ID="365273"
- MY_PW="#{MY_PW}"
Errors
If the pipeline can't be found, you'll see this error:
ERROR: Pipeline {pipelineName} no longer exists