Baseline Work Items in Batches
Function
This API can be called to baseline work items in an IPD project in batches. You can baseline work items in batches based on the ID array of the work items to be baselined.
Calling Method
For details, see Calling APIs.
Authorization Information
No identity policy-based permission required for calling this API.
URI
PUT /v1/ipdprojectservice/projects/{project_id}/issues/batch-update
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition 32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID. Constraints N/A Range A string of 32 characters consisting of letters and digits. Default Value N/A |
Request 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 10 to 32,768 characters Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| id | Yes | Array of strings | Definition ID array of work items to be baselined. You can obtain the value from the Querying Work Items or Querying Tree-shaped Work Items API. The value is id in the response body. Constraints N/A Range N/A Default Value N/A |
| attribute | Yes | attribute object | Definition: Modified work item property. Constraints: N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| result | result object | Definition Result of batch editing. |
| status | String | Definition Response status. Range |
| message | String | Definition Operation failure cause. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| success | Array of IssueBaselineResult objects | Definition Success result. |
| failed | Array of IssueBaselineResult objects | Definition Failure result. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition ID of the changed work item. Range N/A |
| modified_by | String | Definition ID of the work item changer. Range N/A |
| baseline | String | Definition Work item baseline result. Range |
| operation_id | String | Definition Record ID of a work item baseline operation. Range N/A |
| modified_date | String | Definition Work item baseline completion time, which is a Unix timestamp (unit: millisecond). Range N/A |
| number | String | Definition ID of the work item to be baselined. Range N/A |
| title | String | Definition Title of the work item to be baselined. Range N/A |
| fail_message | String | Definition Reason for the work item baseline failure. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. Range N/A |
| error_msg | String | Definition Error description, which is a supplement to error_code. Range N/A |
Example Requests
Updating R&D requirements in batches
PUT https://{endpoint}/v1/ipdprojectservice/projects/8e70d806a8f04d018ea6af6b6ffe7b96/issues/batch-update
{
"id" : [ "1241755389964099584", "1241755327536074752" ],
"attribute" : {
"baseline" : "baselined"
}
} Example Responses
Status code: 200
{
"status" : "success",
"message" : "",
"result" : [ {
"success" : [ {
"modified_by" : "c533da3e53244b589e7175bb766859ac",
"operation_id" : "9921e464-82c0-44a5-98d7-f76be9f5ca54",
"baseline" : "baselined",
"id" : "1241755327536074752",
"modified_date" : "1774431523578"
} ],
"failed" : [ {
"number" : "IR20260320396627",
"id" : "1241755389964099584",
"title" : "IR-Batch Baseline 01",
"fail_message" : "The work item is under baseline review. Complete the review first."
} ],
"success_num" : 1,
"fail_num" : 1
} ]
} Status code: 400
{
"error_code" : "PM.02176813",
"error_msg" : "No permission."
} SDK Sample Code
The SDK sample code is as follows.
Java
Updating R&D requirements in batches
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 49 50 51 52 53 54 55 56 57 | 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.*; import java.util.List; import java.util.ArrayList; public class BatchBaselineIpdIssuesSolution { 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(); BatchBaselineIpdIssuesRequest request = new BatchBaselineIpdIssuesRequest(); request.withProjectId("{project_id}"); BatchBaselineIpdIssuesParam body = new BatchBaselineIpdIssuesParam(); BatchBaselineIpdIssuesParamAttribute attributebody = new BatchBaselineIpdIssuesParamAttribute(); attributebody.withBaseline("baselined"); List<String> listbodyId = new ArrayList<>(); listbodyId.add("1241755389964099584"); listbodyId.add("1241755327536074752"); body.withAttribute(attributebody); body.withId(listbodyId); request.withBody(body); try { BatchBaselineIpdIssuesResponse response = client.batchBaselineIpdIssues(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
Updating R&D requirements in batches
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 | # 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 = BatchBaselineIpdIssuesRequest() request.project_id = "{project_id}" attributebody = BatchBaselineIpdIssuesParamAttribute( baseline="baselined" ) listIdbody = [ "1241755389964099584", "1241755327536074752" ] request.body = BatchBaselineIpdIssuesParam( attribute=attributebody, id=listIdbody ) response = client.batch_baseline_ipd_issues(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
Updating R&D requirements in batches
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 49 50 51 52 53 54 55 56 57 58 59 | 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.BatchBaselineIpdIssuesRequest{} request.ProjectId = "{project_id}" attributebody := &model.BatchBaselineIpdIssuesParamAttribute{ Baseline: "baselined", } var listIdbody = []string{ "1241755389964099584", "1241755327536074752", } request.Body = &model.BatchBaselineIpdIssuesParam{ Attribute: attributebody, Id: listIdbody, } response, err := client.BatchBaselineIpdIssues(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 | OK |
| 400 | Error cause |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot