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

Establishing an Association Between a Work Item and a Gantt Chart

Function

This API is used to associate work items with Gantt charts.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID.

Constraints

A string of 32 characters consisting of letters and digits.

Range

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 Obtaining the Sprint List of a Specified Project API. The value of the id field in the response message body is the release/sprint ID.

Constraints

N/A

Range

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 a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

The value contains 10 to 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

POST https://{endpoint}/v3/plan/5192de5eb435430c8cd41c6ae6028848/f29c3f16d5f54cbab5e167ef9eed3baf/issue

[ 9192109, 9191020, 9184553, 9185630 ]

Example Responses

Status code: 200

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.