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

Creating a Pipeline Group

Function

Creating a Pipeline Group

URI

POST /v5/{project_id}/api/pipeline-group/create

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).

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Pipeline Group Name

project_id

Yes

String

Project name

parent_id

No

String

Parent group ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

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

Create group G1.

POST https://{endpoint}/v5/{project_id}/api/pipeline-group/create

{
  "name" : "G1",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "parent_id" : ""
}

Example Responses

Status code: 200

OK

{
  "id" : "58d55f8a646443a984e7399632b3963e",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "G1",
  "parent_id" : "",
  "path_id" : "58d55f8a646443a984e7399632b3963e",
  "ordinal" : 0,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : null,
  "create_time" : null,
  "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