Help Center/ CodeArts Req/ API Reference/ API/ IPD Project Plan Management/ Querying the Release/Sprint Plan List
Updated on 2026-10-27 GMT+08:00

Querying the Release/Sprint Plan List

Function

This API is used to query the release/sprint plan list.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsreq:plan:list

List

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

GET /v1/planservice/projects/{project_id}/plans/query

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

Constraints

A string of 32 characters consisting of letters and digits.

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

key_word

No

String

Definition:

Release/Sprint name.

Constraints:

N/A

Options:

N/A

Default value:

N/A

updated_time_interval

No

String

Definition

Release/Sprint update time, which is a Unix timestamp (unit: millisecond).

Examples: 1576114296000 and 1576114396000

Constraints

The start time and end time are 13-digit timestamp strings separated by commas (,).

Range

N/A

Default Value

N/A

Request Parameters

Table 3 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

A string of 10 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition

Response status.

Range

  • success: The plan list is queried successfully.

  • error: Failed to query the plan list.

message

String

Definition

Prompt information.

Range

N/A

result

Array of PlanResponseResult objects

Definition

Plan list, including complete information about the release and its child sprints.

page

page object

Definition

Pagination information of the plan list.

Table 5 PlanResponseResult

Parameter

Type

Description

id

String

Definition

ID of a release, sprint, or milestone.

Range

N/A

title

String

Definition

Title

Range

N/A

category

String

Definition

Type. The value is of the enumerated type.

Range

  • PI: release

  • Iteration: sprint

  • PlanMilestone: milestone

description

String

Definition

Description.

Range

N/A

state

String

Definition

Discard flag. The value is of the enumerated type.

Range

  • In use: releases that can be operated normally.

  • Discarded: releases that have been soft deleted.

  • Deleted: releases that have been permanently deleted.

status

String

Definition

Release/Sprint status. The value is of the enumerated type.

Range

  • planned: not started

  • going: ongoing

  • ended

children

Array of PlanResponseResult objects

Definition

Sub-project sprint information.

created_by

String

Definition

Creator ID.

Range

N/A

modified_by

String

Definition

ID of the last updater.

Range

N/A

plan_start_date

Long

Definition

Plan start time, which is a Unix timestamp (unit: millisecond).

Range

N/A

plan_end_date

Long

Definition

Plan completion time, which is a Unix timestamp (unit: millisecond).

Range

N/A

created_date

Long

Definition

Creation time, which is a Unix timestamp (unit: millisecond).

Range

N/A

parent_id

String

Definition

Parent plan ID. When the plan type is iteration, this parameter specifies the release plan to which the work item belongs.

Range

The value is a numeric string of 18 to 19 characters.

baseline

String

Definition

Baseline status. The value is of the enumerated type and indicates whether the plan has been included in baseline management.

Range

  • baselined

  • unbaseline

  • "" (not baselined)

workload

String

Definition

Estimated workload, which is used to identify the required workforce or time investment for the plan. The unit is person/day.

Range

Max. 11 characters.

owner

String

Definition

Owner ID, which identifies the owner of a plan.

Range

A string of 32 characters.

Table 6 page

Parameter

Type

Description

page

Integer

Definition:

Page number.

Options:

N/A

size

Integer

Definition:

Number of pages.

Options:

N/A

count

Integer

Definition:

Number of records displayed on the current page.

Options:

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Requests

GET https://{endpoint}/v1/planservice/projects/{project_id}/plans/query?key_word=gzy&updated_time_interval=1706845235000,1706845835000

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "id" : "956200745322848257",
    "title" : "IR-01",
    "category" : "PI",
    "description" : "Description",
    "state" : "In use",
    "status" : "ended",
    "children" : null,
    "created_by" : "a360371833bf4c558f796fd707b44daf",
    "modified_by" : "a360371833bf4c558f796fd707b44daf",
    "plan_start_date" : 1706845715000,
    "plan_end_date" : 1706845715000,
    "created_date" : 1706845715000,
    "parent_id" : "956239067176935424",
    "baseline" : "baselined",
    "workload" : "workload",
    "owner" : "a360371833bf4c558f796fd707b44daf"
  } ],
  "page" : {
    "page" : 1,
    "size" : 10,
    "count" : 1
  }
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;


public class ListPlanSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        ListPlanRequest request = new ListPlanRequest();
        request.withProjectId("{project_id}");
        try {
            ListPlanResponse response = client.listPlan(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListPlanRequest()
        request.project_id = "{project_id}"
        response = client.list_plan(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := projectman.ProjectManClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := projectman.NewProjectManClient(hcClient)

    request := &model.ListPlanRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ListPlan(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Release/Sprint plan list queried successfully.

400

The error message is returned.

Error Codes

See Error Codes.