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

Querying a Plan

Function

This API is used to query a plan.

Calling Method

For details, see Calling APIs.

URI

GET /v3/plan/{project_id}/{plan_id}/info

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

plan_id

Yes

String

Definition:

Plan ID, which can be obtained by calling the Querying All Plans Visible to the Current User in Pagination Mode API. The value of id in the response message body is the plan ID.

Constraints:

The value must contain 32 characters. Digits and letters are allowed.

Value range:

N/A

Default value:

N/A

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:

The value must contain 32 characters. Digits and letters are allowed.

Value 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 forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

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

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Returned result.

Value range:

N/A

status

String

Definition:

Returned status.

Value range:

success: Command execution succeeds.

error: Command execution failed.

Table 4 result

Parameter

Type

Description

id

String

Definition:

Plan ID.

Value range:

N/A

name

String

Definition:

Plan name.

Value range:

N/A

type

String

Definition:

Plan type.

Value range:

gantt (Gantt chart)

mind (mind map)

project_id

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 API for querying the project list.

Value range:

N/A

creator

creator object

Definition:

Plan creator.

Value range:

N/A

updater

updater object

Definition:

Plan updater.

Value range:

N/A

created_on

String

Definition:

Work item creation time, in timestamp format, for example, 1839340800000.

Value range:

N/A

updated_on

String

Definition:

Date when a work item is updated, in timestamp format, for example, 1839340800000.

Value range:

N/A

Table 5 creator

Parameter

Type

Description

user_id

String

Definition:

User ID.

Value range:

N/A

domain_id

String

Definition:

Domain name ID.

Value range:

N/A

nick_name

String

Definition:

User alias.

Value range:

N/A

first_name

String

Definition:

Username.

Value range:

N/A

Table 6 updater

Parameter

Type

Description

user_id

String

Definition:

User ID.

Value range:

N/A

domain_id

String

Definition:

Domain name ID.

Value range:

N/A

nick_name

String

Definition:

User alias.

Value range:

N/A

first_name

String

Definition:

Username.

Value range:

N/A

Example Requests

{endpoint}/v3/plan/381fcca9c056482d92da3e8b9da71db5/c573497c87414e97a29444c0054c1361/info

Example Responses

Status code: 200

Successful response for querying a single planning interface.

{
  "result" : {
    "id" : "f8f870c2b84548548cb75aa61382b894",
    "name" : "00000",
    "type" : "gantt",
    "project_id" : "c15cc54e338d4506afd9bd8103071ff0",
    "creator" : {
      "user_id" : "xxxxxx",
      "domain_id" : "xxxxxx",
      "nick_name" : "xxxxxx",
      "first_name" : "xxxxxx"
    },
    "updater" : {
      "user_id" : "xxxxxx",
      "domain_id" : "xxxxxx",
      "nick_name" : "xxxxxx",
      "first_name" : "xxxxxx"
    },
    "created_on" : "1752828658000",
    "updated_on" : "1752828658000"
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

Successful response for querying a single planning interface.

Error Codes

See Error Codes.