文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 编辑页获取参数类型的接口
更新时间:2024-11-08 GMT+08:00
分享

编辑页获取参数类型的接口

功能介绍

编辑页获取参数类型的接口

调用方法

请参见如何调用API

URI

GET /v1/job/build-params

请求参数

响应参数

状态码: 200

表1 响应Body参数

参数

参数类型

描述

status

String

状态

error

Object

错误

result

result object

结果

表2 result

参数

参数类型

描述

build_parameters

Array of BuildParams objects

构建参数约束列表

表3 BuildParams

参数

参数类型

描述

name

String

参数名

title

String

名称

params

Array of Params objects

简要构建信息列表

表4 Params

参数

参数类型

描述

name

String

参数名

title

String

名称

type

String

类型

required

String

必填

constraints

Array of Constraints objects

简要构建信息列表

deletion

Boolean

删除

defaults

Boolean

默认

表5 Constraints

参数

参数类型

描述

errormsg

String

错误信息

type

String

类型

value

String

参考值

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Body参数

参数

参数类型

描述

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

错误码

请参见错误码

相关文档