Help Center/ CodeArts Build/ API Reference/ APIs/ Template Management/ Querying a Specific Template Based on Its UUID

Updated on 2025-08-21 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying a Specific Template Based on Its UUID

Function

This API is used to query a specific template based on its UUID.

Calling Method

For details, see Calling APIs.

URI

GET /v1/template/{uuid}/custom

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
uuid	Yes	String	uuid

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
result	QueryTemplatesItems object	Returned result.
error	String	Returned error message.
status	String	Returned status information.

**Table 3** QueryTemplatesItems
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.
nick_name	String	Definition Nickname. Range N/A.
id	String	Definition Primary key ID in the database. Range N/A.
uuid	String	Definition Template ID. Range N/A.
template	QueryTemplateVo 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 Time when the template was created. Range N/A.
domain_id	String	Definition Tenant 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 Tenant 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 4** QueryTemplateVo
Parameter	Type	Description
steps	Array of CreateBuildJobStepsResponse objects	Definition Build actions being executed. Range N/A.
actions	Object	Definition Build actions. Range N/A.
auto_update_sub_module	Boolean	Definition Whether submodules are automatically updated. Range N/A.
image	String	Definition Image address. Range N/A.
image_source	String	Definition Image source address. Range N/A.

**Table 5** 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 6** 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 7** 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 8** 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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Example Requests

GET https://{endpoint}/v1/template/f79b7d8a71b34bd8b3f2bb5fabf06f5c/custom

Example Responses

Status code: 200

{
  "result" : {
    "favourite" : true,
    "nick_name" : "gray1",
    "id" : "1772",
    "uuid" : "f79b7d8a71b34bd8b3f2bb5fabf06f5c",
    "template" : {
      "steps" : [ {
        "properties" : { },
        "module_id" : "devcloud2018.codeci_action_20018.action",
        "name" : "Upload Software Package to Release Repo",
        "version" : null,
        "enable" : true
      } ],
      "auto_update_sub_module" : false,
      "image" : false,
      "image_source" : false
    },
    "type" : "codeci",
    "public" : true,
    "name" : "test-123",
    "create_time" : "2025-05-19T15:00:40.000+00:00",
    "domain_id" : "764f03980afc4e5c97a1a9a73c1d707a",
    "weight" : 0,
    "user_id" : "6d7a54d45bf44a0684a7a682f719ffd9",
    "user_name" : "hwstaff_codeci_gray",
    "domain_name" : "hwstaff_codeci_gray",
    "scope" : "custom",
    "description" : "",
    "tool_type" : "",
    "intl_description" : { },
    "parameters" : [ {
      "name" : "hudson.model.StringParameterDefinition",
      "params" : [ {
        "name" : "name",
        "value" : "codeBranch"
      }, {
        "name" : "type",
        "value" : "normalparam"
      }, {
        "name" : "defaultValue",
        "value" : "master"
      }, {
        "name" : "description",
        "value" : "Code branch (system-predefined parameter)"
      }, {
        "name" : "deletion",
        "value" : "false"
      }, {
        "name" : "defaults",
        "value" : "true"
      }, {
        "name" : "staticVar",
        "value" : "false"
      }, {
        "name" : "sensitiveVar",
        "value" : "false"
      } ]
    } ],
    "i18n" : { }
  },
  "error" : null,
  "status" : "success"
}