Obtaining the Operation History (V2)
Function
This API is used to obtain the operation history (V2).
Calling Method
For details, see Calling APIs.
URI
GET /v2/issues/get-record
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: The value must contain 32 characters. Digits and letters are allowed. Value range: 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 |
limit |
No |
Integer |
Definition: Number of records displayed on each page. Constraints: N/A Value range: Minimum length: 1 character. Maximum length: 10 characters. Default value: 10 |
offset |
No |
Integer |
Definition: Pagination index. The offset is an integer multiple of limit. For example, if the value of offset is 0, the return starts from the first record. If the value of offset is 10, the return starts from the eleventh record. Constraints: N/A Value range: Minimum value: 0. Maximum value: 10,000. Default value: Default value: 0. |
type |
No |
String |
Description: Project type. Constraints: N/A Value range: Scrum Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition: Returned result. |
status |
String |
Definition: Returned status. Value range: success and error |
Parameter |
Type |
Description |
---|---|---|
offset |
Integer |
Definition: Pagination index. The offset is an integer multiple of limit. Value range: Minimum value: 0. Maximum value: 10,000. |
record |
Array of RecordRecord objects |
Definition: Historical record list. |
limit |
Integer |
Definition: Number of records displayed on each page. Value range: Minimum value: 1. Maximum value: 1,000. |
journals_total |
Integer |
Definition: Total number of log records. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Operation batch ID in the historical records. Operations performed at the same time share an identical ID. Value range: N/A |
notes |
String |
Definition: Remarks or comments related to log records. Value range: N/A |
created_on |
String |
Definition: Timestamp when a historical record is created. Value range: N/A |
user |
IssueUserVO object |
Definition: Operator information. |
details |
Array of DetailsRecord objects |
Definition: Detailed information about historical records. |
Parameter |
Type |
Description |
---|---|---|
first_name |
String |
Definition: Username. Value range: N/A |
identifier |
String |
Definition: Unique ID of the author. Value range: N/A |
image_id |
String |
Definition: User avatar ID. Value range: N/A |
nick_name |
String |
Definition: User alias. Value range: N/A |
name |
String |
Definition: Username with tenant information. Value range: N/A |
id |
Integer |
Definition: Digital ID of a user. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Historical record ID. Value range: N/A |
journal_id |
Integer |
Definition: Historical record ID. Value range: N/A |
property |
String |
Definition: Changed attribute, for example, attr. Value range: N/A |
new_value |
String |
Definition: Value of an attribute after modification. Value range: N/A |
name |
String |
Definition: Field name of a historical record operation. Value range: N/A |
operation |
String |
Definition: Operation performed on an attribute, for example, create, delete, and modify. Value range: N/A |
old_value |
String |
Definition: Value of an attribute before modification. Value range: N/A |
Example Requests
GET http://{endpoint}/v2/issues/get-record?issue_id=9175005&project_id=c15cc54e338d4506afd9bd8103071ff0&limit=10&offset=0&type=scrum&_=1753080349806
Example Responses
Status code: 200
The API for retrieving historical operation records has responded successfully.
{ "result" : { "offset" : 0, "record" : [ { "id" : 11248513, "created_on" : "1752829690000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270161, "journal_id" : 11248513, "property" : "attr", "old_value" : "", "new_value" : "1752854400000", "name" : "due_date", "operation" : "Batch edit" } ] }, { "id" : 11248513, "created_on" : "1752829690000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270162, "journal_id" : 11248513, "property" : "attr", "old_value" : "", "new_value" : "1752768000000", "name" : "start_date", "operation" : "Batch edit" } ] }, { "id" : 11248512, "notes" : "", "created_on" : "1752829683000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270149, "journal_id" : 11248512, "property" : "attr", "old_value" : "", "new_value" : "444", "name" : "subject", "operation" : "Create" } ] }, { "id" : 11248512, "notes" : "", "created_on" : "1752829683000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270150, "journal_id" : 11248512, "property" : "attr", "old_value" : "", "new_value" : "<p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> As </span><User role></p><p><br></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> I want </span><to do something></p><p><br></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> so as to </span><do something> </p>", "name" : "description", "operation" : "Create" } ] }, { "id" : 11248512, "notes" : "", "created_on" : "1752829683000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270151, "journal_id" : 11248512, "property" : "attr", "new_value" : "New", "name" : "status_id", "operation" : "New" } ] }, { "id" : 11248512, "notes" : "", "created_on" : "1752829683000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270152, "journal_id" : 11248512, "property" : "attr", "old_value" : "", "new_value" : "xxxxxx", "name" : "assigned_to_id", "operation" : "Create" } ] }, { "id" : 11248512, "notes" : "", "created_on" : "1752829683000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270153, "journal_id" : 11248512, "property" : "attr", "old_value" : "", "new_value" : "1", "name" : "order", "operation" : "Create" } ] }, { "id" : 11248512, "notes" : "", "created_on" : "1752829683000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270154, "journal_id" : 11248512, "property" : "attr", "new_value" : "Medium", "name" : "priority_id", "operation" : "Create" } ] }, { "id" : 11248512, "notes" : "", "created_on" : "1752829683000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270155, "journal_id" : 11248512, "property" : "attr", "new_value" : "Minor", "name" : "severity_id", "operation" : "Create" } ] }, { "id" : 11248512, "notes" : "", "created_on" : "1752829683000", "user" : { "id" : 1111, "name" : "xxxxxx", "first_name" : "xxxxxx", "identifier" : "xxxxxx", "nick_name" : "xxxxxx" }, "details" : [ { "id" : 15270156, "journal_id" : 11248512, "property" : "attr", "old_value" : "", "new_value" : "xxxxxx", "name" : "assigned_cc", "operation" : "Create" } ] } ], "limit" : 10, "journals_total" : 14 }, "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
The API for retrieving historical operation records has responded successfully. |
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