Help Center/CodeArts Pipeline/API Reference/API/Manage by group/Querying the Pipeline Group Tree
Updated on 2023-11-28 GMT+08:00
View PDF

Querying the Pipeline Group Tree

Function

Querying the Pipeline Group Tree

URI

GET /v5/{project_id}/api/pipeline-group/tree

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of PipelineGroupVo objects

OK

Table 4 PipelineGroupVo

Parameter

Type

Description

id

String

Group ID

domain_id

String

TenantID

project_id

String

Project ID

name

String

Group Name

parent_id

String

Parent group ID.

path_id

String

Group Path ID

ordinal

Integer

No.

creator

String

Creator ID.

updater

String

Update User ID

create_time

Long

Creation time.

update_time

Long

Updated

children

Array of PipelineGroupVo objects

Subgroup List

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error Message

error_code

String

Error code.

Example Requests

GET https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipeline-group/tree

Example Responses

Status code: 200

OK

[ {
  "id" : "894daf0db79c4ccb839490770fa06596",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "Creating a Group 22",
  "parent_id" : "",
  "path_id" : "894daf0db79c4ccb839490770fa06596",
  "ordinal" : 2,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : null,
  "create_time" : 1698487536000,
  "update_time" : null,
  "children" : null
}, {
  "id" : "2ca78947b25847a9ab68a07d8ef1347b",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "Creating group 11",
  "parent_id" : "",
  "path_id" : "2ca78947b25847a9ab68a07d8ef1347b",
  "ordinal" : 1,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : null,
  "create_time" : 1698487008000,
  "update_time" : null,
  "children" : null
}, {
  "id" : "58d55f8a646443a984e7399632b3963e",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "G2",
  "parent_id" : "",
  "path_id" : "58d55f8a646443a984e7399632b3963e",
  "ordinal" : 0,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : "847a5317086c41798469d0868535943a",
  "create_time" : 1698484566000,
  "update_time" : 1698485674000,
  "children" : [ {
    "id" : "d805c90bf99049d3a49e83d2024df6b8",
    "domain_id" : "ce8df55870164338a72d7e828a966a2a",
    "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
    "name" : "Creating group 3",
    "parent_id" : "58d55f8a646443a984e7399632b3963e",
    "path_id" : "58d55f8a646443a984e7399632b3963e.d805c90bf99049d3a49e83d2024df6b8",
    "ordinal" : 1,
    "creator" : "847a5317086c41798469d0868535943a",
    "updater" : "847a5317086c41798469d0868535943a",
    "create_time" : 1698487527000,
    "update_time" : 1698487868000,
    "children" : null
  }, {
    "id" : "ebb779b3b9f742e181b1f6829fa1aca0",
    "domain_id" : "ce8df55870164338a72d7e828a966a2a",
    "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
    "name" : "Creating a Group",
    "parent_id" : "58d55f8a646443a984e7399632b3963e",
    "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0",
    "ordinal" : 0,
    "creator" : "847a5317086c41798469d0868535943a",
    "updater" : null,
    "create_time" : 1698485344000,
    "update_time" : null,
    "children" : [ {
      "id" : "1b80aa3df0984e9caffefdc4e557524e",
      "domain_id" : "ce8df55870164338a72d7e828a966a2a",
      "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
      "name" : "Creating group 4",
      "parent_id" : "ebb779b3b9f742e181b1f6829fa1aca0",
      "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0.1b80aa3df0984e9caffefdc4e557524e",
      "ordinal" : 2,
      "creator" : "847a5317086c41798469d0868535943a",
      "updater" : null,
      "create_time" : 1698487502000,
      "update_time" : null,
      "children" : null
    }, {
      "id" : "6bc8a3cda52c41fe84d71c9ff86161ea",
      "domain_id" : "ce8df55870164338a72d7e828a966a2a",
      "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
      "name" : "Creating group 3",
      "parent_id" : "ebb779b3b9f742e181b1f6829fa1aca0",
      "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0.6bc8a3cda52c41fe84d71c9ff86161ea",
      "ordinal" : 1,
      "creator" : "847a5317086c41798469d0868535943a",
      "updater" : null,
      "create_time" : 1698486710000,
      "update_time" : null,
      "children" : null
    } ]
  } ]
} ]

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic:Manage by group