Creating a Build Template (Version 3)

Function

This API is used to create a build template.

Calling Method

For details, see Calling APIs.

URI

POST /v3/templates/create

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
template	Yes	CreateTemplate object	Definition Build action template. It is named using the camel case convention. Constraints N/A. Range N/A. Default Value N/A.
name	Yes	String	Definition Template name. Constraints N/A. Range N/A. Default Value N/A.
description	No	String	Definition Template description. Constraints N/A. Range N/A. Default Value N/A.
tool_type	No	String	Definition Tool type. Constraints N/A. Range N/A. Default Value N/A.
parameters	No	Array of CreateBuildJobParameter objects	Definition A list of build execution parameters. Constraints N/A. Range N/A. Default Value N/A.

**Table 3** CreateTemplate
Parameter	Mandatory	Type	Description
steps	Yes	Array of CreateTemplateSteps objects	Definition Build actions being executed. Constraints N/A. Range N/A. Default Value N/A.

**Table 4** CreateTemplateSteps
Parameter	Mandatory	Type	Description
properties	No	Map<String,Object>	Definition Detailed build actions. Constraints N/A. Range N/A. Default Value N/A.
module_id	Yes	String	Definition Build module ID. Constraints N/A. Range N/A. Default Value N/A.
name	No	String	Definition Build module name. Constraints N/A. Range N/A. Default Value N/A.
version	No	String	Definition Build version. Constraints N/A. Range N/A. Default Value N/A.
enable	No	Boolean	Definition Whether enabled or not. Constraints N/A. Range ● true: Enabled. ● false: Disabled. Default Value true

**Table 5** CreateBuildJobParameter
Parameter	Mandatory	Type	Description
name	No	String	Definition Parameter definition name. The default value is hudson.model.StringParameterDefinition. Constraints N/A. Range N/A. Default Value N/A.
params	No	Array of CreateBuildJobParameterParam objects	Definition Subparameters of build execution parameters. Constraints N/A. Range N/A. Default Value N/A.

**Table 6** CreateBuildJobParameterParam
Parameter	Mandatory	Type	Description
name	No	String	Definition Parameter field name. Constraints N/A. Range N/A. Default Value N/A.
value	No	String	Definition Parameter field value. Constraints N/A. Range N/A. Default Value N/A.
limits	No	Array of LimitsParam objects	Definition Restrictions on enumeration parameters. Constraints N/A. Range N/A. Default Value N/A.

**Table 7** LimitsParam
Parameter	Mandatory	Type	Description
disable	No	String	Definition Whether enabled or not. The default value is 0, indicating "enabled". Constraints N/A. Range N/A. Default Value N/A.
display_name	No	String	Definition Parameter display name. Constraints N/A. Range N/A. Default Value N/A.
name	No	String	Definition Parameter name. Constraints N/A. Range N/A. Default Value N/A.

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
result	CreateTemplatesItems object	Definition Template query result. Range N/A.
error	String	Definition Returned error message. Range N/A.
status	String	Definition Returned status information. Range ● success: The API call is successful. ● fail: The API call failed.

**Table 9** CreateTemplatesItems
Parameter	Type	Description
favourite	Boolean	Definition Whether a template is favorited. Range ● true: The template is favorited. ● false: The template is not added to favorites.
id	String	Definition ID in the database. Range N/A.
uuid	String	Definition UUID. Range N/A.
template	QueryTemplate object	Definition Build action template. It is named using the camel case convention. Range N/A.
type	String	Definition Template type. Range N/A.
public	Boolean	Definition Whether the template is public. Range ● true: Public. ● false: Non-public.
name	String	Definition Template name. Range N/A.
create_time	String	Definition Creation time. Range N/A.
domain_id	String	Definition Domain ID. Range N/A.
weight	Double	Definition Weight. Range N/A.
user_id	String	Definition User ID. Range N/A.
user_name	String	Definition Username. Range N/A.
domain_name	String	Definition Domain name. Range N/A.
scope	String	Definition Template scope. For a user-defined template, the default value is custom. Range N/A.
description	String	Definition Template description. Range N/A.
tool_type	String	Definition Build tool type. It indicates if the build is defined by YAML or actions. Range N/A.
intl_description	Object	Definition intl description. Range N/A.
parameters	Array of CreateBuildJobParameterResponse objects	Definition A list of build execution parameters. Range N/A.
i18n	Object	Definition Internationalization (i18n). Range N/A.

**Table 10** QueryTemplate
Parameter	Type	Description
steps	Array of CreateBuildJobStepsResponse objects	Definition Build actions being executed. Range N/A.

**Table 11** CreateBuildJobStepsResponse
Parameter	Type	Description
properties	Map<String,Object>	Definition Build action parameters. Range N/A.
module_id	String	Definition Build action ID. Range N/A.
name	String	Definition Build action name. Range N/A.
version	String	Definition Build action version. Range N/A.
enable	Boolean	Definition Whether to enable automatic build task. Range ● true: Enabled. ● false: Disabled.

**Table 12** CreateBuildJobParameterResponse
Parameter	Type	Description
name	String	Definition Parameter definition name. The default value is hudson.model.StringParameterDefinition. Range N/A.
params	Array of CreateBuildJobParameterParamResponse objects	Definition Subparameters of build execution parameters. Range N/A.

**Table 13** CreateBuildJobParameterParamResponse
Parameter	Type	Description
name	String	Definition Parameter field name. Range N/A.
value	String	Definition Parameter field value. Range N/A.
limits	Array of LimitsParamResponse objects	Definition Restrictions on enumeration parameters. Range N/A.

**Table 14** LimitsParamResponse
Parameter	Type	Description
disable	String	Definition Whether enabled or not. The default value is 0, indicating "enabled". Range N/A.
display_name	String	Definition Parameter display name. Range N/A.
name	String	Definition Parameter name. Range N/A.

Status code: 400

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 19** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

POST https://{endpoint}/v3/templates/create

{
  "name" : "example",
  "description" : "123",
  "tool_type" : "123123",
  "template" : {
    "steps" : [ {
      "module_id" : "devcloud2018.codeci_action_20043.action",
      "name" : "Build with Maven",
      "enable" : true,
      "properties" : null
    } ]
  },
  "parameters" : [ {
    "name" : "hudson.model.StringParameterDefinition",
    "params" : [ {
      "name" : "name",
      "value" : "codeBranch"
    }, {
      "name" : "type",
      "value" : "normalparam"
    }, {
      "name" : "defaultValue",
      "value" : "master"
    }, {
      "name" : "description",
      "value" : "description"
    }, {
      "name" : "deletion",
      "value" : "false"
    }, {
      "name" : "defaults",
      "value" : "true"
    }, {
      "name" : "staticVar",
      "value" : "false"
    }, {
      "name" : "sensitiveVar",
      "value" : "false"
    } ]
  } ]
}

Example Responses

Status code: 200

{
  "result" : {
    "public" : true,
    "favourite" : false,
    "id" : "6561b2ced7a6751941fdc8cd",
    "uuid" : "2d9031c079624376824fe1e2731615dc",
    "template" : {
      "steps" : null
    },
    "type" : "codeci",
    "name" : "oych_test_temp_ladadad12122313",
    "create_time" : "2023-11-25T08:39:42.098+00:00",
    "domain_id" : "60021bab32fd450aa2cb89226f425e06",
    "weight" : 0,
    "user_id" : "ae22fd035f354cfa8d82a3f1c8940446",
    "user_name" : "testUser",
    "domain_name" : "testUser",
    "scope" : "custom",
    "description" : "123",
    "intl_description" : { },
    "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
      } ]
    } ],
    "i18n" : { }
  },
  "error" : null,
  "status" : "success"
}