Help Center/ CodeArts Req/ API Reference/ API/ Scrum Project Statuses/ Plans of a Scrum Project/ Establishing an Association Between a Work Item and a Gantt Chart
Updated on 2025-09-10 GMT+08:00

Establishing an Association Between a Work Item and a Gantt Chart

Function

This API is used to establish an association between a work item and a Gantt chart.

Calling Method

For details, see Calling APIs.

URI

POST /v3/plan/{project_id}/{plan_id}/issue

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

Regular expression: [A-Za-z0-9]{32}

Options:

N/A

Default value:

N/A

plan_id

Yes

String

Definition:

Unique ID of a release or sprint. You can obtain the release/sprint ID using the Querying the Release/Sprint List API. The value of the id field in the response message body is the release/sprint ID.

Constraints:

N/A

Options:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Range:

Minimum length: 10 character. Maximum length: 32,768 characters.

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of integers

Definition:

ID of the work item to be associated with the Gantt chart.

Constraints:

A maximum of 100 work items can be associated.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition:

Status of the response body.

Value range:

success: successful

error: failed

Example Requests

{endpoint}//v3/plan/5192de5eb435430c8cd41c6ae6028848/f29c3f16d5f54cbab5e167ef9eed3baf/issue

[ 9192109, 9191020, 9184553, 9185630 ]

Example Responses

Status code: 200

Response body.

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.