Querying the Operation History of a Test Plan
Function
This API is used to query the operation history of a test plan.
Calling Method
For details, see Calling APIs.
URI
GET /v1/projects/{project_id}/plans/{plan_id}/journals
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project UUID, which uniquely identifies a project. For details about how to obtain the project UUID, see Obtaining a Project ID. Constraints 32 characters (letters and digits). Range N/A. Default Value N/A. |
plan_id |
Yes |
String |
Definition ID of a test plan. Constraints 11 to 34 characters. Range N/A. Default Value N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
Yes |
Long |
Definition The position where the query starts. Constraints ≥ 0 Range 0–2000000 Default Value N/A. |
limit |
Yes |
Long |
Definition Number of items displayed on each page. Constraints N/A. Range 1–200 Default Value N/A. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
[Array elements] |
Array of TestPlanJournalList objects |
Definition Response structure for querying the operation history of a test plan in a project. Range N/A. |
Parameter |
Type |
Description |
---|---|---|
detail |
Array of TestPlanJournalDetail objects |
Historical record details. |
operate_time |
String |
Change time. |
operator |
NameAndId object |
Definition Operator Range N/A. |
plan_id |
String |
Definition Test plan ID. Range 11 to 34 characters. |
project_id |
String |
Definition Project UUID, which uniquely identifies a project. For details about how to obtain the project UUID, see Obtaining a Project ID. Constraints 32 characters (letters and digits). Range N/A. |
Parameter |
Type |
Description |
---|---|---|
added |
Array of NameAndId objects |
Records of adding test plan resources (work items or test cases). |
deleted |
Array of NameAndId objects |
Records of removing test plan resources (work items or test cases). |
journalized_type |
String |
Definition Specific type in change records. Example: test case or requirement. Range N/A. |
type |
String |
Definition Whether the basic information or a resource is changed (adding or removing requirements/test cases). Range N/A. |
updated |
Array of AttributeChange objects |
Definition Change of the basic information about the test plan. It includes the plan name, test type, plan processor, version, associated sprint, start date, end date, and description. Range N/A. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Object ID. Range N/A. |
name |
String |
Definition Object name. Range N/A. |
Parameter |
Type |
Description |
---|---|---|
attribute_type |
String |
Definition Changed test plan attributes. Range N/A. |
new_value |
String |
Definition Changed value. Range N/A. |
old_value |
String |
Definition Value before the change. Range N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range N/A. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range N/A. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range N/A. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range N/A. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range N/A. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range N/A. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range N/A. |
Example Requests
get https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans/9b26f58ec29943f681804a6628779a23/journals?offset=1&limit=10
Example Responses
Status code: 201
OK
[ { "detail" : [ { "added" : [ { "id" : "ID", "name" : "Name" } ], "deleted" : [ { "id" : "ID", "name" : "Name" } ], "journalized_type" : "plan", "type" : "resource/attribute", "updated" : [ { "attribute_type" : "name", "new_value" : "tester", "old_value" : "test" } ] } ], "operate_time" : "2021-07-10", "operator" : { "id" : "ID", "name" : "Name" }, "plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea", "project_id" : "9b26f58ec29943f681804a6628779a23" } ]
SDK Sample Code
The 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 47 |
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.cloudtest.v1.region.CloudtestRegion; import com.huaweicloud.sdk.cloudtest.v1.*; import com.huaweicloud.sdk.cloudtest.v1.model.*; public class ShowPlanJournalsSolution { 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); CloudtestClient client = CloudtestClient.newBuilder() .withCredential(auth) .withRegion(CloudtestRegion.valueOf("<YOUR REGION>")) .build(); ShowPlanJournalsRequest request = new ShowPlanJournalsRequest(); request.withProjectId("{project_id}"); request.withPlanId("{plan_id}"); try { ShowPlanJournalsResponse response = client.showPlanJournals(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 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcloudtest.v1 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 = CloudtestClient.new_builder() \ .with_credentials(credentials) \ .with_region(CloudtestRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowPlanJournalsRequest() request.project_id = "{project_id}" request.plan_id = "{plan_id}" response = client.show_plan_journals(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cloudtest.NewCloudtestClient( cloudtest.CloudtestClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowPlanJournalsRequest{} request.ProjectId = "{project_id}" request.PlanId = "{plan_id}" response, err := client.ShowPlanJournals(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More SDK Sample Code
For SDK code examples in more programming languages, visit API Explorer and click the Sample Code tab.
Status Codes
Status Code |
Description |
---|---|
201 |
OK |
400 |
Bad request |
401 |
Unauthorized |
404 |
Not found |
500 |
Internal server error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank 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