Get job's parameter definitions
get
/v1/jobs/{jobName}/params
Returns a list of job parameter definitions in YAML format
Request
Path Parameters
-
jobName: string
job name
Response
Supported Media Types
- text/plain
200 Response
{jobParam in YAML}
400 Response
ERROR: Job identified by {jobIdentifier} no longer exists
Examples
The following example shows how to return a list of job parameter definitions for job Params, 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/jobs/Params/params
Enter host password for user 'alex.admin':
params:
# 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 job can't be found, you'll see one of the following errors:
ERROR: Job {jobName} no longer exists
ERROR: Job identified by {jobIdentifier} no longer exists
If the job is protected and you are not authorized to view it, you'll see this error:
ERROR: Not authorized