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

Querying the Plan List

Function

This API is used to query all plans visible to users in the current project in pagination mode.

Calling Method

For details, see Calling APIs.

URI

POST /v3/plan/{project_id}/managements

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

search

No

String

Definition:

Group name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

user_ids

No

Array of strings

Definition:

Creator UUID list. You can obtain the value using the Obtaining the Current User Information API. The value of user_id in the response message body is the 32-character UUID of the user.

Constraints:

N/A

sort

No

String

Definition:

Sorting rule of the queried data.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

page_no

Yes

Integer

Definition:

Current page number.

Constraints:

N/A

Value range:

Minimum value: 1. Maximum value: 9,999.

Default value:

1

type

No

String

Definition:

Plan type.

Constraints:

N/A

Value range:

gantt (Gantt chart)

mind (mind map)

Default value:

N/A

page_size

Yes

Integer

Definition:

Number of rows on each page.

Constraints:

N/A

Value range:

Minimum value: 1. Maximum value: 200.

Default value:

1

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

plans

Array of PlanVO objects

Definition:

Project plan list.

total

Long

Definition:

Total number of queried project plans.

Options:

N/A

minds

Long

Definition:

Number of plans whose type is mind map.

Options:

N/A

gantts

Long

Definition:

Number of plans whose type is Gantt chart.

Options:

N/A

Table 4 PlanVO

Parameter

Type

Description

result

result object

Definition:

Plan list.

status

String

Definition:

Processing status of a request.

Value range:

success: successful

error: failed

Table 5 result

Parameter

Type

Description

id

String

Definition:

Plan ID.

Value range:

N/A

name

String

Definition:

Plan title.

Value range:

N/A

type

String

Definition:

Plan type.

Value range:

gantt (Gantt chart)

mind (mind map)

project_id

String

Definition:

Project ID.

Value range:

N/A

creator

creator object

Definition:

Creator information.

Table 6 creator

Parameter

Type

Description

user_id

String

Definition:

User ID of the creator.

Value range:

N/A

domain_id

String

Definition:

Tenant ID.

Value range:

N/A

nick_name

String

Definition:

Creator alias.

Value range:

N/A

first_name

String

Definition:

Username of the creator.

Value range:

N/A

Example Requests

POST https://{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/managements

{
  "sort" : "",
  "search" : "",
  "page_no" : 1,
  "page_size" : 15,
  "type" : "gantt",
  "user_ids" : [ "a360371833bf4c558f796fd707b44daf" ]
}

Example Responses

Status code: 200

Query all plan data visible to the current user in the project.

{
  "result" : {
    "plans" : [ {
      "id" : "bf56512ab4e544c29d03d068711ca56a",
      "name" : "Gantt test",
      "type" : "gantt",
      "project_id" : "919bb351ef424e2daaf3dd80c179fae9",
      "creator" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "nick_name" : "Sam",
        "first_name" : "devcloud_devcloud_s00404480_01"
      },
      "updater" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "nick_name" : "Sam",
        "first_name" : "devcloud_devcloud_s00404480_01"
      },
      "created_on" : "1749730042000",
      "updated_on" : "1749730527000",
      "img_url" : "/v1/upload/919bb351ef424e2daaf3dd80c179fae9/202506/1749730526922581391.png"
    } ],
    "total" : "1",
    "minds" : "0",
    "gantts" : "1"
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

Query all plan data visible to the current user in the project.

Error Codes

See Error Codes.