Help Center/ CodeArts Pipeline/ API Reference/ API/ Template Management/ Adding a Pipeline Template to Favorites
Updated on 2026-09-24 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding a Pipeline Template to Favorites

Function

This API is used to add a pipeline template to favorites.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{tenant_id}/api/pipeline-templates/{templateId}/favorite

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

tenant_id

Yes

String

Definition:

Tenant ID, that is, domain ID of a user.

Constraints:

N/A

Range:

The value consists of 32 characters, including only digits and letters.

Default value:

N/A

templateId

Yes

String

Parameter description:

Template ID.

Constraints:

None.

Value range:

32 characters, including only digits and letters.

Default value:

None.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

flag

Yes

Boolean

Definition:

Whether to add the object to favorites.

Constraints:

N/A

Value range:

  • true: The object has been added to favorites.

  • false: The object is not added to favorites.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

templateId

String

Definition:

Template ID.

Value range:

N/A

Default value:

N/A

Example Requests

POST https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-templates/d6e65b15f6d94fda85c6644e8136a1f7/favorite?flag=true

Example Responses

Status code: 200

{
  "templateId" : "d6e65b15f6d94fda85c6644e8136a1f7"
}

Status Codes

Status Code

Description

200

Added to favorites.

Error Codes

See Error Codes.

Parent topic: Template Management