编辑页获取参数类型的接口
功能介绍
编辑页获取参数类型的接口
调用方法
请参见如何调用API。
URI
GET /v1/job/build-params
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
状态 |
error |
Object |
错误 |
result |
result object |
结果 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数名 |
title |
String |
名称 |
type |
String |
类型 |
required |
String |
必填 |
constraints |
Array of Constraints objects |
简要构建信息列表 |
deletion |
Boolean |
删除 |
defaults |
Boolean |
默认 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v1/job/build-params
响应示例
状态码: 200
OK
{ "result" : { "build_parameters" : [ { "name" : "hudson.model.StringParameterDefinition", "title" : "String Parameters", "params" : [ { "name" : "name", "title" : "Parameter", "type" : "text", "required" : true, "constraints" : [ { "region" : null, "language" : null, "type" : "maxLen", "value" : "128", "errormsg" : "Enter a maximum of 128 characters." }, { "region" : null, "language" : null, "type" : "minLen", "value" : "1", "errormsg" : "Enter at least 1 character." }, { "region" : null, "language" : null, "type" : "regex", "value" : "^[a-z0-9A-Z\\_]{1,128}$", "errormsg" : "Enter 1 to 128 characters. Only letters (not case-sensitive), digits, and underscores (_) are allowed." } ], "deletion" : false, "defaults" : false } ] } ] }, "error" : null, "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。