Help Center/ CodeArts Build/ API Reference/ APIs/ Group Management/ Modifying Group Information

Updated on 2025-09-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Modifying Group Information

Function

This API is used to modify group information.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/job/{project_id}/group/update

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition CodeArts project ID. For details about how to obtain the CodeArts project ID, see Obtaining a CodeArts Project ID. Constraints N/A. Range Use a 32-character string containing a mix of digits and letters. Default Value N/A.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
id	No	String	Primary key ID.
name	No	String	Group name.
project_id	No	String	CodeArts project ID. For details about how to obtain the CodeArts project ID, see Obtaining a CodeArts Project ID.
parent_id	No	String	Parent group ID.
group_id	No	String	Task group ID.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	Array of result objects	Returned result.
error	String	Returned error message.
status	String	Returned status information.

**Table 4** result
Parameter	Type	Description
id	String	Primary key ID.
name	String	Group name.
project_id	String	CodeArts project ID. ID of the project to which the build task belongs.
parent_id	String	Parent group ID.
group_id	String	Task group ID.
domain_id	String	Tenant ID.
ordinal	String	Group index.
create_user	String	Creator.
update_user	String	Modifier (the user who performs modification).
create_time	String	Creation time.
update_time	String	Modification time.
path_id	String	Group address ID.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

PUT https://{endpoint}/v1/job/{project_id}/group/update

Example Responses

Status code: 200

{
  "result" : [ {
    "id" : "70e158b6054e442893d7f5a79d34ce61",
    "domain_id" : "60021bab32fd450aa2cb89226f425e06",
    "project_id" : "923785f9674548259144259077bc6a98",
    "name" : "777 (Group testing)",
    "parent_id" : "b13c933bbc6f4d09a98ef09e4cc07e17",
    "path_id" : "b13c933bbc6f4d09a98ef09e4cc07e17.66936fb8ea74472dbe7b05a46a50e62c",
    "ordinal" : 2,
    "create_user" : "test1",
    "update_user" : "test1",
    "create_time" : "2025-06-05T07:31:13+0800",
    "update_time" : "2025-06-09T09:40:58+0800"
  } ],
  "error" : null,
  "status" : "success"
}