Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Projects for Which a Pipeline Can Be Created

Updated on 2025-11-12 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Projects for Which a Pipeline Can Be Created

Function

This API is used to query projects for which a pipeline can be created.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/project/query-related-project

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Definition: Tenant ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page_index	No	Integer	Definition: Page number for pagination query. Constraints: N/A Value range: The value is greater than 0. Default value: 1.
page_size	No	Integer	Definition: Number of records on each page. Constraints: N/A Value range: The value is greater than 0. Default value: N/A
search	No	String	Definition: Name for fuzzy search. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number of projects. Value range: N/A
project_info_list	Array of ProjectInfo objects	Definition: Project details in the project list. Value range: N/A

**Table 4** ProjectInfo
Parameter	Type	Description
id	Integer	Definition: Project ID. Value range: N/A
identifier	String	Definition: Project identifier. Value range: The value consists of 32 characters, including digits and letters.
name	String	Definition: Project name. Value range: N/A
type	String	Definition: Project type. Value range: N/A
status	Integer	Definition: Project status. Value range: N/A
enable_create_pipeline	Boolean	Definition: Whether a pipeline can be created. Value range: true: The pipeline can be created. false The pipeline cannot be created.

Example Requests

None

Example Responses

Status code: 200

{
  "project_info_list" : [ {
    "id" : 12181083,
    "identifier" : "85190bf7c85d490685603702939ed24b",
    "name" : "Test",
    "type" : "scrum",
    "status" : 1,
    "enable_create_pipeline" : true
  } ],
  "total" : 1
}