文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 查询官方模版
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询官方模版

功能介绍

查询官方模版

调用方法

请参见如何调用API。

URI

GET /v1/template/officialtemplates

表1 Query参数

参数

是否必选

参数类型

描述

name

否

String

检索的模板的名字模糊查询

page

否

String

分页页码， 表示从此页开始查询

默认取值：

0

page_size

否

String

每页显示的条目数量，page_size小于等于100

默认取值：

20

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

result

result object

返回值

error

String

返回错误信息

status

String

返回状态信息
表3 result

参数

参数类型

描述

total_size

Number

总数

items

Array of TemplateList objects

模版列表
表4 TemplateList

参数

参数类型

描述

language

String

模版支持的语言

favourite

Boolean

是否收藏模板

uuid

String

uuid

type

String

模板类别

name

String

模板命名

weight

Double

权重

scope

String

模板范围，自定义模板默认为：custom,官方模版为：official

description

String

模板说明

nick_name

String

昵称

public

Boolean

模板是否公开

tool_type

String

构建工具类型，mono、npm、maven等

template

QueryTemplate object

构建步骤模板，需封装为驼峰式命名

parameters

Array of Parameter objects

构建执行参数列表
表5 QueryTemplate

参数

参数类型

描述

steps

Array of CreateBuildJobSteps objects

构建执行的步骤
表6 CreateBuildJobSteps

参数

参数类型

描述

properties

Map<String,Object>

构建步骤属性参数

module_id

String

构建步骤id

name

String

构建步骤名称

version

String

构建步骤版本

enable

Boolean

是否开启
表7 Parameter

参数

参数类型

描述

name

String

参数定义名，默认为hudson.model.StringParameterDefinition

params

Array of CreateBuildJobParameterParam objects

构建执行参数子参数
表8 CreateBuildJobParameterParam

参数

参数类型

描述

name

String

参数字段名

value

String

参数字段值

limits

Array of LimitsParam objects

枚举类参数限制
表9 LimitsParam

参数

参数类型

描述

disable

String

是否生效，默认为"0"，为生效状态

display_name

String

参数展示的名字

name

String

参数名字

状态码： 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/template/officialtemplates

响应示例

状态码： 200

OK

{
  "result" : {
    "items" : [ {
      "public" : true,
      "favourite" : false,
      "nick_name" : "021",
      "uuid" : "2d9031c079624376824fe1e2731615dc",
      "template" : {
        "steps" : null
      },
      "type" : "codeci",
      "name" : "oych_test_temp_ladadad12122313",
      "weight" : 0,
      "scope" : "custom",
      "description" : "123",
      "parameters" : [ {
        "name" : "hudson.model.StringParameterDefinition",
        "params" : [ {
          "name" : "name",
          "value" : "codeBranch",
          "limits" : null
        }, {
          "name" : "type",
          "value" : "normalparam",
          "limits" : null
        }, {
          "name" : "defaultValue",
          "value" : "master",
          "limits" : null
        }, {
          "name" : "description",
          "value" : "Code branch, predefined parameters",
          "limits" : null
        }, {
          "name" : "deletion",
          "value" : "false",
          "limits" : null
        }, {
          "name" : "defaults",
          "value" : "true",
          "limits" : null
        }, {
          "name" : "staticVar",
          "value" : "false",
          "limits" : null
        }, {
          "name" : "sensitiveVar",
          "value" : "false",
          "limits" : null
        } ]
      } ]
    }, {
      "public" : true,
      "favourite" : false,
      "nick_name" : "021",
      "uuid" : "e6e1ac0c94254534bd6c952f201d621d",
      "template" : {
        "steps" : null
      },
      "type" : "codeci",
      "name" : "oych_test_sdk_template",
      "weight" : 0,
      "scope" : "custom",
      "description" : "oych_test_sdk_template",
      "parameters" : [ {
        "name" : "hudson.model.StringParameterDefinition",
        "params" : [ {
          "name" : "name",
          "value" : "codeBranch",
          "limits" : null
        }, {
          "name" : "type",
          "value" : "normalparam",
          "limits" : null
        }, {
          "name" : "defaultValue",
          "value" : "master",
          "limits" : null
        }, {
          "name" : "description",
          "value" : "Code branch, predefined parameters",
          "limits" : null
        }, {
          "name" : "deletion",
          "value" : "false",
          "limits" : null
        }, {
          "name" : "defaults",
          "value" : "true",
          "limits" : null
        }, {
          "name" : "staticVar",
          "value" : "false",
          "limits" : null
        }, {
          "name" : "sensitiveVar",
          "value" : "false",
          "limits" : null
        } ]
      } ]
    } ],
    "total_size" : 41
  },
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档