Querying Template Details

Updated on 2023-11-28 GMT+08:00

View PDF

Function

URI

GET /v5/{tenant_id}/api/pipeline-templates/{template_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	TenantID
template_id	Yes	String	The template ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
id	String	The template ID.
name	String	The template name.
icon	String	Template Icon
manifest_version	String	Version
language	String	Language
description	String	Template Description
is_system	Boolean	Indicates whether the template is a system template.
region	String	Site
domain_id	String	Tenant ID.
variables	Array of CustomVariable objects	User-defined
creator_id	String	Creator ID.
updater_id	String	Editor ID
create_time	Integer	Create Date
update_time	Integer	Date
is_collect	String	Favorite
is_show_source	Boolean	Indicates whether to display the pipeline source.
definition	String	Template orchestration JSON, including stages

**Table 3** CustomVariable
Parameter	Type	Description
pipeline_id	String	Pipeline ID
name	String	Custom Parameter Name
sequence	Integer	User-defined Parameter Sequence
type	String	Custom Parameter Type
value	String	Default values of customized parameters
is_secret	Boolean	Indicates whether the parameter is private.
description	String	User-defined Parameter Description
is_runtime	Boolean	Indicates whether to set during running.
limits	Array of objects	Limited
is_reset	Boolean	Reset or Not
latest_value	String	Latest Parameter Value
runtime_value	String	Value Transferred During Running

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Error Message
error_code	String	Error code.

Example Requests

Querying Pipeline Template Details

GET https://{endpoint}/v5/a5f63758220947b7821e70ae2734c01d/api/pipeline-templates/deb18013bb6c4659b160b15fd7468644

Example Responses

Status code: 200

{
  "id" : "deb18013bb6c4659b160b15fd7468644",
  "name" : "Creating a Pipeline Template-20230112115711",
  "icon" : null,
  "manifest_version" : "3.0",
  "language" : "none",
  "description" : "",
  "is_system" : false,
  "region" : "region01",
  "domain_id" : "70ffec613024477bbaf266128bd9778d",
  "variables" : [ ],
  "creator_id" : "5ffd41c9df9d4506862ce27e209bb106",
  "updater_id" : "5ffd41c9df9d4506862ce27e209bb106",
  "create_time" : 1673495851000,
  "update_time" : 1673495851000,
  "is_collect" : null,
  "is_show_source" : true,
  "definition" : "{\"stages\":[{\"name\":\"Phase _1\",\"sequence\":\"0\",\"jobs\":[{\"stage_id\":1673495831907,\"identifier\":\"16734958501367554c26c-561b-4831-a906-e88316c8e674\",\"name\": \"New Task\",\"depends_on\":[] ,\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\":[],\"exec_type\":\"AGENTLESS_JOB\",\"sequence\":0}],\"identifier\":\"0\",\"pre\":[{\"task\":\"official_devcloud_autoTrigger\",\"sequence\":0}],\"post\":null,\"depends_on\":[],\"run_always\":false}]}"
}