Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Available Predefined Parameters
Updated on 2025-03-25 GMT+08:00

Querying Available Predefined Parameters

Function

This API is used to query available predefined parameters.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/list-system-vars

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

CodeArts project ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipeline_id

Yes

String

Parameter description:

Pipeline ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

[items]

Array of ListPipelineSystemVarsResp objects

Response body.

Table 3 ListPipelineSystemVarsResp

Parameter

Type

Description

name

String

Parameter name.

value

String

Parameter value.

type

String

Parameter type.

description

String

Parameter description.

isShow

Boolean

Whether to display.

ordinal

Integer

Parameter No.

isAlias

Boolean

Parameter alias.

kind

String

Parameter context type.

contextName

String

Context name.

sourceIdentifier

String

Identifiers.

Example Requests

GET https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/0747d5a7099e45f69dc1d099945909a9/list-system-vars

Example Responses

Status code: 200

Response body.

[ {
  "name" : "PROJECT_ID",
  "value" : null,
  "type" : "string",
  "description" : "ID of the project to which the current pipeline belongs",
  "isShow" : true,
  "ordinal" : 0,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "PIPELINE_ID",
  "value" : null,
  "type" : "string",
  "description" : "ID of the current pipeline",
  "isShow" : true,
  "ordinal" : 1,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "PIPELINE_NUMBER",
  "value" : null,
  "type" : "string",
  "description" : "Pipeline execution number",
  "isShow" : true,
  "ordinal" : 2,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "COMMIT_ID",
  "value" : null,
  "type" : "string",
  "description" : "ID of the last commit for execution",
  "isShow" : true,
  "ordinal" : 3,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "COMMIT_ID_SHORT",
  "value" : null,
  "type" : "string",
  "description" : "Short ID of the last code commit for execution",
  "isShow" : true,
  "ordinal" : 4,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "TIMESTAMP",
  "value" : null,
  "type" : "string",
  "description" : "Pipeline execution timestamp. For example: 20211222124301",
  "isShow" : true,
  "ordinal" : 5,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "PIPELINE_TRIGGER_TYPE",
  "value" : null,
  "type" : "string",
  "description" : "Pipeline triggering type, including Manual, Scheduler, RollBack, and WebHook (CreateTag, Note, Issue, MR, and Push).",
  "isShow" : true,
  "ordinal" : 6,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "REPO_URL",
  "value" : null,
  "type" : "string",
  "description" : "Code repository address (HTTPS)",
  "isShow" : true,
  "ordinal" : 11,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "PIPELINE_RUN_ID",
  "value" : null,
  "type" : "string",
  "description" : "Pipeline execution ID",
  "isShow" : true,
  "ordinal" : 24,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "MERGE_ID",
  "value" : null,
  "type" : "string",
  "description" : "Merge request ID",
  "isShow" : true,
  "ordinal" : 25,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
}, {
  "name" : "WEBHOOK_PAYLOAD",
  "value" : null,
  "type" : "string",
  "description" : "Webhook request load information",
  "isShow" : true,
  "ordinal" : 27,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
} ]

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.