Batch Editing Work Items (V2)

Function

This API is used to edit work items in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v2/workitem/issues

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory. Value range: Minimum length: 10 characters. Maximum length: 32,768 characters. Default value: N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
assigned_to_id	No	String	Definition: Digital ID of the module owner, which is obtained by calling the Obtaining the Member List of a Specified Project API. The value of user_num_id in the response message body is the ID of the module owner. Constraints: N/A Value range: N/A Default value: N/A
issue_ids	No	String	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
project_id	No	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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result. Value range: N/A
status	String	Definition: Returned status. Value range: success: Command execution succeeds. error: Command execution failed.

**Table 4** result
Parameter	Type	Description
project	project object	Definition: Project. Value range: N/A
journal_ids	Array of strings	Definition: Historical record ID. Value range: N/A
error_issues	Array of integers	Definition: Work items that fail to be edited. Value range: N/A
versions_issues	Array of strings	Definition: Sprint version of a work item. Value range: N/A
success_issues	Array of strings	Definition: Work items that are successfully edited. Value range: N/A

**Table 5** project
Parameter	Type	Description
id	Integer	Definition: Digital ID of a project. Value range: N/A
identifier	String	Definition: Project UUID. Value range: N/A
total	Integer	Definition: Total number of work items that are edited in batches. Value range: N/A
close	Integer	Definition: Whether the project is closed. Value range: 0: (not closed) 1: (closed)
role	Integer	Definition: Number of work items that are edited in batches. Value range: N/A
type	String	Definition: Work item type. Value range: Scrum
archive	Boolean	Definition: Whether a work item is archived. Value range: true (archived) false (not archived)
mem_count	Integer	Definition: Number of projects. Value range: N/A

Example Requests

{endpoint}/v2/workitem/issues

{
  "assigned_to_id" : "4091",
  "issue_ids" : "9191020",
  "project_id" : "5192de5eb435430c8cd41c6ae6028848"
}

Example Responses

Status code: 200

Response to the success response of the interface for editing work items in batches.

{
  "result" : {
    "project" : {
      "id" : 35138974,
      "identifier" : "5192de5eb435430c8cd41c6ae6028848",
      "total" : 0,
      "close" : 0,
      "role" : 0,
      "type" : "scrum",
      "archive" : true,
      "mem_count" : 0
    },
    "journal_ids" : [ ],
    "error_issues" : [ 9191020 ],
    "versions_issues" : [ ],
    "success_issues" : [ ]
  },
  "status" : "success"
}