Obtaining Historical Records of Work Items
Function
This API is used to obtain historical records of work items.
Calling Method
For details, see Calling APIs.
URI
GET /v4/projects/{project_id}/issue/{issue_id}/records
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 |
issue_id |
Yes |
Integer |
Definition: Work item ID, which can be obtained from the Performing Advanced Query of Work Items API. The value of the id field in the response message body is the work item ID. Constraints: The value must contain 1 to 10 digits. Value range: Minimum length: 1 character. Maximum length: 10 characters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Definition: Pagination index, which is the offset. Constraints: Offset must be an integral multiple of limit. If limit equals 10, then valid offset values are 0, 10, 20, and so on. Options: Minimum value: 0. Default value: 0 |
limit |
No |
Integer |
Definition: Number of records displayed on each page. Constraints: N/A Options: Minimum value: 1. Maximum value: 1,000. Default value: 10 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token. Constraints: Mandatory. Range: Minimum length: 10 character. Maximum length: 32,768 characters. Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
records |
Array of IssueRecordV4 objects |
Definition: Work item record details. |
total |
Integer |
Definition: Total number of operation records. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
created_time |
Long |
Definition: Time when an operation record is created. Options: N/A |
details |
Array of details objects |
Definition: Operation record. |
id |
Integer |
Definition: Operation record ID. Options: N/A |
user |
user object |
Definition: User who performs an operation on a work item. |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Operation record ID. Options: N/A |
name |
String |
Definition: Operation field name. Options: N/A |
new_value |
String |
Definition: Current value. Options: N/A |
old_value |
String |
Definition: Last record. Options: N/A |
operation |
String |
Definition: Operation. Options: JOURNAL_1: modify JOURNAL_2: create JOURNAL_3: delete JOURNAL_4: clone JOURNAL_5: import JOURNAL_6: transfer code commits JOURNAL_7: update the import JOURNAL_8: batch edit ARCHIVING: archive CANCEL_ARCHIVING: cancel archiving ASSOCIATE_TEST_CASE: associate a case CANCEL_ASSOCIATED_TEST_CASE: cancel associating a case ASSOCIATE_CODE_BRANCH: associate a branch ASSOCIATE_ISSUE: associate a work item CANCEL_ASSOCIATED_ISSUE: cancel associating a work item CLOSE_SPRINT: end a sprint |
property |
String |
Definition: Operation attribute. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
nick_name |
String |
Definition: Alias. Options: N/A |
user_id |
String |
Definition: 32–digit UUID of a user. Options: N/A |
user_name |
String |
Definition: Login name. Options: N/A |
user_num_id |
Integer |
Definition: Digital ID of a user. Options: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Example Requests
Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/issue/3458/records
Example Responses
Status code: 200
OK
{ "records" : [ { "id" : 1234, "created_time" : 1617764919000, "user" : { "user_num_id" : 4091, "user_name" : "demo_user_name", "nick_name" : "aaa", "user_id" : "a360371833bf4c558f796fd707b44daf" }, "details" : [ { "property" : 1, "old_value" : 1, "new_value" : 2, "operation" : "Batch edit", "id" : 3597, "name" : "Title" } ] } ], "total" : 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 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.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ListIssueRecordsV4Solution { 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(); ListIssueRecordsV4Request request = new ListIssueRecordsV4Request(); request.withProjectId("{project_id}"); request.withIssueId({issue_id}); try { ListIssueRecordsV4Response response = client.listIssueRecordsV4(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 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 = ListIssueRecordsV4Request() request.project_id = "{project_id}" request.issue_id = {issue_id} response = client.list_issue_records_v4(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" 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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := projectman.NewProjectManClient( projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListIssueRecordsV4Request{} request.ProjectId = "{project_id}" request.IssueId = int32({issue_id}) response, err := client.ListIssueRecordsV4(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 |
Bad Request |
401 |
Unauthorized |
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