Help Center/ CodeArts Req/ API Reference/ API/ IPD Work Item Management/ Creating Work Items in Batches

Updated on 2026-10-13 GMT+08:00

View PDF

Creating Work Items in Batches

Function

This API is used to create work items in batches.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

POST /v2/ipdprojectservice/projects/{project_id}/issues/batch

**Table 1** Path Parameters
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

**Table 2** Request header 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	Yes	Array of IssueCreateEntity objects	Parameter for creating work items.

**Table 4** IssueCreateEntity
Parameter	Mandatory	Type	Description
title	Yes	String	Definition Work item title. Constraints N/A Range 2 to 256 characters. Default Value N/A
description	Yes	String	Definition Work item description field. Constraints N/A Range 0 to 500,000 characters. Default Value N/A
category	Yes	String	Definition Work item type code. This field is mandatory for work item editing. The value is the type of the current work item, which is not updated. Constraints N/A Range Multiple values are supported. Use commas (,) to separate them. For system device projects, options include RR, SF, IR, SR, AR, Task, and Bug. For standalone software projects, options include RR, SF, IR, US, Task, and Bug. Default Value N/A
category_layer_id	Yes	String	Definition ID of the work item type hierarchy. This parameter affects the display of work item levels. Obtain the value from the API for obtaining the model tree configuration. Find the corresponding category_code in the category_layer_config of the response body based on the category parameter. The id at the same level as category_code is the work item type hierarchy ID. Constraints N/A Range N/A Default Value N/A
parent_id	Yes	String	Definition Parent work item ID. Constraints This field is mandatory for child work item creation. In other scenarios, this field is optional. Range N/A Default Value N/A
status	Yes	String	Definition Work item status code. Obtain the value from the Querying the Work Item Status API. The value is code in the response body. Constraints N/A Range N/A Default Value N/A
assignee	Yes	UserEntity object	Definition Work item owner. Constraints This parameter is mandatory for bugs. For other work item types, this parameter is optional. The default owner is the current user.
recipient	No	Array of UserEntity objects	Definition Raw requirement receiver. Constraints This parameter is mandatory for RRs. For other work item types, this parameter is unavailable.
assigned_cc	No	Array of UserEntity objects	Definition Cc recipient of a work item. Multiple Cc recipients are supported. Constraints A work item can be copied to a maximum of 50 recipients.
plan_end_date	No	String	Definition Planned end date of a work item. Constraints A string of 0 to 13 digits. The negative sign (-) can be used as the prefix. Range Timestamp. Default Value N/A
workload	No	String	Definition Planned workloads of a work item. Constraints N/A Range Numeric string in 0 to 999999999.9. Default Value N/A
link	No	String	Definition IDs of associated items of a work item. Constraints Multiple associated items are separated by commas (,). A work item supports a maximum of 50 associated items. Range N/A Default Value N/A
labels	No	Array of LabelEntity objects	Definition Work item label. Constraints N/A
custom_fields	No	Array of FieldCodeValuePair objects	Definition Mapping for custom fields of work items. System fields added by users are also displayed in this column. Constraints N/A
ir2feature	No	String	Definition Association field of IRs and SFs. Constraints This field can be set for IRs. Range N/A Default Value N/A
priority	No	String	Definition Work item priority. Constraints This field can be set for RRs, SFs, FEs, IRs, SRs, ARs, tasks, and bugs. Range Low Medium High Default Value N/A
related_network_security	No	String	Definition Whether network security is involved. Constraints This field is available only for R&D requirements. Range yes: Network security is involved. no: Network security is not involved. Default Value N/A
collaboratives	No	String	Definition R&D requirement collaboration task ID. Obtain the value from the Querying Tree-shaped Work Items API. The value is collaboratives in the response body. Constraints Collaboration task ID. This field is available for IRs, SRs, ARs, and USs. Range N/A Default Value N/A
business_domain	No	String	Definition Domain field. Constraints This field is available for FEs, SFs, IRs, SRs, ARs, and bugs. Range software soft-hardware hardware Performance Functions O&M Operations User experience Privacy protection Compliance Resilience (reliability/availability) Resilience (hazard detection and recovery) Transparent Harmless Security API Cost Maintainability Other DFX Availability others Default Value N/A
plan_pi	No	String	Definition Work item release plan ID. Constraints This field is available for SRs, ARs, USs, tasks, and bugs by default. Range N/A Default Value N/A
submitted_by	No	Array of UserEntity objects	Definition Work item proposer. Constraints This field is available only for RRs and bugs.
ir2rr	No	String	Definition ID of the RR associated with the IR. Constraints This field is available only for IRs. Separate multiple values by commas (,). Range N/A Default Value N/A
feature_set	No	String	Definition Feature set ID. Constraints This field is available only for SFs and FEs. Range N/A Default Value N/A

**Table 5** UserEntity
Parameter	Mandatory	Type	Description
id	No	String	Definition User ID. Obtain it by calling the API for querying project members. The value of id in the response message body is the user ID. Constraints N/A Range N/A Default Value N/A
name	No	String	Definition Username. Constraints N/A Range 2 to 64 characters. Default Value N/A
nick_name	No	String	Definition User alias. Constraints N/A Range 2 to 30 characters Default Value N/A

**Table 6** LabelEntity
Parameter	Mandatory	Type	Description
id	No	String	Definition Label ID, which is the value of id in the response body returned by calling the API for querying the label list. Constraints N/A Range A string of 18 to 19 digits. Default Value N/A
category_types	No	Array of strings	Definition Code of the work item type to which a label belongs. Constraints N/A Default Value N/A
label_type	No	String	Definition Type of the work item to which the label belongs, corresponding to the type field of the work item. The options are as follows. Constraints N/A Range raw requirement feature (system feature) requirement (R&D requirement) task bug Default Value N/A
color	No	String	Definition Label RGB color. Constraints 0 to 16 characters. Range The available color codes and their descriptions are as follows: #86CAFF: light sky blue #6DDEBB: aquamarine #A6DD82: light green #FAC20A: golden yellow #FA9841: sandy orange #F66F6A: light coral #F3689A: pink #A97AF8: medium purple #71757F: slate gray #5E7CE0: soft blue #207AB3: steel blue #169E6C: sea green #6CA83B: olive green #B58200: dark golden yellow #B54E04: burnt orange #B02121: dark red #AD215B: dark pink #572DB3: deep violet #4F4F4F: dark gray #3C51A6: indigo blue Default Value N/A
title	No	String	Definition Label title. Constraints 1 to 30 characters. Range N/A Default Value N/A

**Table 7** FieldCodeValuePair
Parameter	Mandatory	Type	Description
code	No	String	Definition Code of a custom field of a work item. Obtain the value from the Querying Field Templates API. The value is code in the response body. Constraints 0 to 32 characters. Range N/A Default Value N/A
value	No	String	Definition Custom field value of a work item. Constraints Use commas (,) to separate multiple values. Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
result	Array of IssueCreateResponse objects	Definition Return value of the created work item.
status	String	Definition Response status. Range success: The response is successful. error: The response failed.
message	String	Definition Failure cause. Range N/A

**Table 9** IssueCreateResponse
Parameter	Type	Description
id	String	Definition ID of the work item to be updated. You can obtain the value from the API for querying tree-shaped work items. The value is id in the response body. Range N/A
title	String	Definition Work item title. You can obtain the value from the API for querying tree-shaped work items. The value is title in the response body. Range N/A
description	String	Definition Work item description. You can obtain the value from the API for querying tree-shaped work items. The value is description in the response body. Range N/A
type	String	Definition Broad category of a work item. This field is not available when you create or edit a work item. It is used only for display. You can obtain the value of this field from the type field in the response body of the API for querying tree-shaped work items Range requirement (R&D requirement), bug, task, feature, and raw_requirement.
number	String	Definition Work item ID. You can obtain the value from the API for querying tree-shaped work items. The value is number in the response body. Range N/A
category	String	Definition Work item type. Obtain the value from the API for querying tree-shaped work items. The value is category in the response body. Range Multiple values are supported. Use commas (,) to separate them. For system device projects, options include RR, SF, IR, SR, AR, Task, and Bug. For standalone software projects, options include RR, SF, IR, US, Task, and Bug.
parent_id	String	Definition Parent work item ID. You can obtain the value from the API for querying tree-shaped work items. The value is parent_id in the response body. Range N/A
project_id	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 API for querying the project list. Range N/A
status	String	Definition Work item status code. You can obtain the value from the API for querying tree-shaped work items. The value is status in the response body. Range N/A
state	String	Definition Work item lifecycle. The options are In use and Discarded. You can obtain the value from the API for querying tree-shaped work items. The value is state in the response body. Range In use and Discarded
assignee	UserEntity object	Definition Work item owner.
assigned_cc	Array of UserEntity objects	Definition Cc recipient of a work item. Multiple Cc recipients are supported. A work item can be copied to a maximum of 50 recipients.
created_by	UserEntity object	Definition Work item creator.
created_time	String	Definition Work item creation time, which is a Unix timestamp (unit: millisecond). Range N/A
modified_by	UserEntity object	Definition Latest updater of a work item.
modified_time	String	Definition Last update time of the work item, which is a Unix timestamp (unit: millisecond). Range N/A
plan_end_date	String	Definition Planned end date of a work item, which is a Unix timestamp (unit: millisecond). Range N/A
close_time	String	Definition Work item closure time, which is a Unix timestamp (unit: millisecond). Range N/A
workload	String	Definition Planned workloads of a work item. One decimal place is reserved. The value ranges from 0 to 999999999.9. Range 0-999999999.9
workload_sum	String	Definition Actual workloads of a work item. Range 0-999999999.9
tenant_id	String	Definition ID of the tenant to which the work item belongs. Obtain the value from the Querying Tree-shaped Work Items API. The value is tenant_id in the response body. Range N/A
link	String	Definition ID of the associated item of a work item. You can obtain the value from the API for querying tree-shaped work items. The value is link in the response body. Range N/A
suspended	Boolean	Definition Whether a work item is suspended. Range true and false
status_modified_time	String	Definition Time when the work item status changes, which can be used to calculate the number of days that the work item stays in the current status. The value is a Unix timestamp, in milliseconds. Range N/A
labels	Array of LabelEntity objects	Definition Work item label.
custom_fields	Array of FieldCodeValuePair objects	Definition Custom field mapping of a work item. System fields added by users are also in this column. { "code":"field code", "value":"field value" }.
children	Array of IssueEntity objects	Definition Child work item set of a work item.
path	String	Definition Path of a child work item. Range N/A
ir2feature	String	Definition Association field of IRs and SFs. Range N/A
need_break	String	Definition Whether a work item needs to be broken down. Range yes: Breakdown is required. no: Breakdown is not required.
break_status	String	Definition Breakdown status. decomposed: broken down undecomposed: not broken down --: N/A Range decomposed, undecomposed, and --
baseline	String	Definition Work item baseline status. Range null: not baselined baselined baseline-reviewing: baseline review in progress
priority	String	Definition Work item priority. Some work items have this field. Range Low Medium High
related_network_security	String	Definition Whether network security is involved. Range N/A Range yes: Network security is involved. no: Network security is not involved.
collaboratives	String	Definition R&D requirement collaboration task ID. Obtain the value from the Querying Tree-shaped Work Items API. The value is collaboratives in the response body. Range N/A
business_domain	String	Definition Domain field. Range software soft-hardware hardware Performance Functions O&M Operations User experience Privacy protection Compliance Resilience (reliability/availability) Resilience (hazard detection and recovery) Transparent Harmless Security API Cost Maintainability Other DFX Availability others
plan_pi	String	Definition Work item release plan ID. You can obtain the value from the API for querying tree-shaped work items. The value is plan_pi in the response body. Range N/A
plan_iteration	String	Definition ID of the sprint plan in which the work item is completed. For bugs, the value is the ID of the fix sprint plan. You can obtain the value from the API for querying tree-shaped work items. The value is plan_iteration in the response body. Range N/A
change_status	String	Definition Work item change status. change-reviewing: being reviewed changed: changed unchange or null: not changed Range change-reviewing, changed, unchange, and null
no_break_reason	String	Definition Reason for no breakdown required. need_break is no. Range 0 to 512 characters.
submitted_by	Array of UserEntity objects	Definition Work item proposer.
ir2rr	String	Definition ID of the RR associated with the IR. Use commas (,) to separate multiple IDs. Range N/A
feature_set	String	Definition Feature set ID. Obtain the value from the Querying Tree-shaped Work Items API. The value is feature_set in the response body. Range N/A
expected_repair_date	String	Definition Expected fixing time. This field is available only for bugs. The value is a Unix timestamp, in milliseconds. Range N/A
found_pi	String	Definition ID of the release plan where a bug is found. This field is available only for bugs. You can obtain the value from the API for querying tree-shaped work items. The value is found_pi in the response body. Range N/A
found_iteration	String	Definition ID of the sprint plan where a bug is found. This field is available only for bugs. You can obtain the value from the API for querying tree-shaped work items. The value is found_iteration in the response body. Range N/A
reason_analysis	String	Definition Reason analysis. Range 0 to 50,000 characters.
repair_solution	String	Definition Fix solution. This field is available only for bugs. Range N/A
test_report	String	Definition Test report. This field is available only for bugs. Range N/A
sys_no_repair_reason	String	Definition Reason why rectification is not required. This field is available only for bugs. Range N/A
sys_activation_reason	String	Definition Activation reason. This field is available only for bugs. Range N/A
sys_return_reason	String	Definition Reason for return. This field is available only for bugs. Range N/A
test_failures_times	Integer	Definition Number of times that regression failed. This field is available only for bugs. Range N/A
close_type	String	Definition Closure type. This field is available only for bugs. The options are problem_solved, problem_to_requirement, duplicate_problem, and not_a_problem, which mean that the bug was fixed and closed, the bug was converted into a requirement and closed, the bug was closed as a duplicate, the bug was closed because it was not a valid issue, respectively. Range problem_solved, problem_to_requirement, duplicate_problem, and not_a_problem

**Table 10** IssueEntity
Parameter	Type	Description
id	String	Definition ID of the work item to be updated. You can obtain the value from the API for querying tree-shaped work items. The value is id in the response body. Range A string of 18 to 19 digits (corresponding to the id field of a work item).
title	String	Definition Work item title. You can obtain the value from the API for querying tree-shaped work items. The value is title in the response body. Range 1 to 256 characters.
description	String	Definition Work item description. You can obtain the value from the API for querying tree-shaped work items. The value is description in the response body. Range 1 to 500,000 characters.
type	String	Definition Broad category of a work item. This field is not available when you create or edit a work item. It is used only for display. You can obtain the value of this field from the type field in the response body of the API for querying tree-shaped work items Range requirement (R&D requirement) bug task feature raw_requirement
number	String	Definition Work item ID. You can obtain the value from the API for querying tree-shaped work items. The value is number in the response body. Range N/A
category	String	Definition Work item type. Obtain the value from the API for querying tree-shaped work items. The value is category in the response body. Range Multiple values are supported. Use commas (,) to separate them. For system device projects, options include RR, SF, IR, SR, AR, Task, and Bug. For standalone software projects, options include RR, SF, IR, US, Task, and Bug.
category_layer_id	String	Definition ID of the work item type hierarchy. This parameter affects the display of work item levels. Obtain the value from the API for obtaining the model tree configuration. Find the corresponding category_code in the category_layer_config of the response body based on the category parameter. The id at the same level as category_code is the work item type hierarchy ID. Range N/A
parent_id	String	Definition Parent work item ID. You can obtain the value from the API for querying tree-shaped work items. The value is parent_id in the response body. Range A string of 18 to 19 digits (corresponding to the id field of a parent work item).
project_id	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 API for querying the IPD project list. Range Unique project ID consisting of 32 characters, which is obtained through the API for querying the IPD project list.
status	String	Definition Work item status code. Obtain the value from the Querying the Work Item Status API. The value is code in the response body. Range 2 to 32 characters.
state	String	Definition Work item lifecycle. The options are In use and Discarded. You can obtain the value from the API for querying tree-shaped work items. The value is state in the response body. Range In use: work items that can be operated properly Discarded: soft-deleted work items that can be restored from the recycle bin Deleted: permanently deleted work items that cannot be restored
assignee	UserEntity object	Definition Work item owner.
assigned_cc	Array of UserEntity objects	Definition Cc recipient of a work item. Multiple Cc recipients are supported. The array element is the UserEntity object. Range N/A
created_by	UserEntity object	Definition Work item creator.
created_time	String	Definition Work item creation time, which is a Unix timestamp (unit: millisecond). Range N/A
modified_by	UserEntity object	Definition Latest updater of a work item.
modified_time	String	Definition Last update time of the work item, which is a Unix timestamp (unit: millisecond). Range N/A
plan_end_date	String	Definition Planned end date of a work item, which is a Unix timestamp (unit: millisecond). Range N/A
close_time	String	Definition Work item closure time, which is a Unix timestamp (unit: millisecond). Range N/A
workload	String	Definition Planned workloads of a work item. Range 0-999999999.9
workload_sum	String	Definition Actual workloads of a work item. Range 0-999999999.9
tenant_id	String	Definition ID of the tenant to which the work item belongs. Obtain the value from the Querying Tree-shaped Work Items API. The value is tenant_id in the response body. Range 32 characters.
link	String	Definition IDs of associated items of a work item. Range 0 to 2,048 characters.
suspended	Boolean	Definition Whether a work item is suspended. Range true: suspended false: not suspended
status_modified_time	String	Definition Time when the work item status changes, which can be used to calculate the number of days that the work item stays in the current status. The value is a Unix timestamp, in milliseconds. Range N/A
labels	Array of LabelEntity objects	Definition Work item label. The array element is a LabelEntity object. Range N/A
custom_fields	Array of FieldCodeValuePair objects	Definition Custom field mapping of a work item. System fields added by users are also in this column. The format is {"code":"field code","value":"field value"}. The array element is a FieldCodeValuePair object. Range N/A
children	Array of IssueEntity objects	Definition Child work item set of a work item. The array element is an IssueEntity object. Range N/A
path	String	Definition Path of a child work item. Range 0 to 256 characters.
ir2feature	String	Definition Association field of IRs and SFs. Range N/A
need_break	String	Definition Whether a work item needs to be broken down. Range yes: Breakdown is required. no: Breakdown is not required.
break_status	String	Definition Breakdown status. Range decomposed undecomposed Empty: N/A
baseline	String	Definition Work item baseline status. Range null: not baselined baselined baseline-reviewing: baseline review in progress
priority	String	Definition Work item priority. Some work items have this field. Range Low Medium High
related_network_security	String	Definition Whether network security is involved. Range yes: Network security is involved. no: Network security is not involved.
collaboratives	String	Definition R&D requirement collaboration task ID. Obtain the value from the Querying Tree-shaped Work Items API. The value is collaboratives in the response body. Range 0 to 256 characters.
business_domain	String	Definition Domain field. Range software soft-hardware hardware Performance Functions O&M Operations User experience Privacy protection Compliance Resilience (reliability/availability) Resilience (hazard detection and recovery) Transparent Harmless Security API Cost Maintainability Other DFX Availability others
plan_pi	String	Definition Work item release plan ID. You can query the plan list by calling the API for querying the release/sprint plan list. The id field of the object with category=PI in PlanVO in the returned parameters is the sprint plan ID. Range A string of 18 to 19 digits.
plan_iteration	String	Definition ID of the sprint plan in which the work item is completed. The field is the fixing sprint plan ID for bugs. You can query the plan list by calling the API for querying the release/sprint plan list. The id field of the object with category=Iteration in PlanVO in the returned parameters is the sprint plan ID. Range A string of 18 to 19 digits.
change_status	String	Definition Work item change status. Range change-reviewing changed unchange null: unchanged
no_break_reason	String	Definition Reason for no breakdown required. Range 0 to 512 characters.
submitted_by	Array of UserEntity objects	Definition Work item proposer. The array element is the UserEntity object. Range N/A
ir2rr	String	Definition ID of the RR associated with the IR. Obtain the value from the API for querying work items or querying tree-shaped work items. The value of id in the response body is the work item ID. Range 0 to 1,024 characters.
feature_set	String	Definition Feature set ID. Obtain the value of this parameter using the Querying Feature Sets API. The value of id in the response body is the feature set ID. Range A string of 18 to 19 digits.
expected_repair_date	String	Definition Expected fixing time. This field is available only for bugs. The value is a Unix timestamp, in milliseconds. Range 11 to 19 characters.
found_pi	String	Definition ID of the release plan where a bug is found. This field is available only for bugs. You can query the plan list by calling the API for querying the release/sprint plan list. The id field of the object with category=PI in PlanVO in the returned parameters is the sprint plan ID. Range A string of 18 to 19 digits.
found_iteration	String	Definition ID of the sprint plan where a bug is found. This field is available only for bugs. You can query the plan list by calling the API for querying the release/sprint plan list. The id field of the object with category=Iteration in PlanVO in the returned parameters is the sprint plan ID. Range A string of 18 to 19 digits.
reason_analysis	String	Definition Reason analysis. Range 0 to 50,000 characters.
repair_solution	String	Definition Fix solution. This field is available only for bugs. Range 0 to 50,000 characters.
test_report	String	Definition Test report. This field is available only for bugs. Range 0 to 50,000 characters.
sys_no_repair_reason	String	Definition Reason why rectification is not required. This field is available only for bugs. Range 0 to 50,000 characters.
sys_activation_reason	String	Definition Activation reason. This field is available only for bugs. Range 0 to 50,000 characters.
sys_return_reason	String	Definition Reason for return. This field is available only for bugs. Range 0 to 50,000 characters.
test_failures_times	Integer	Definition Number of times that regression failed. This field is available only for bugs. Range 0–999999
close_type	String	Definition Closure type. Range problem_solved: resolved problem_to_requirement: converted to requirement duplicate_problem: duplicate not_a_problem: closed as non-issue
plan_owner	UserEntity object	Definition Work item planning owner, responsible for work item planning and plan development.
doing_owner	UserEntity object	Definition Work item implementation owner, responsible for the specific implementation and execution of work items.
delivered_owner	UserEntity object	Definition Work item delivery owner, responsible for the delivery and release of work items.
checking_owner	UserEntity object	Definition Work item acceptance owner, responsible for the final acceptance of work items.
test_owner	UserEntity object	Definition Work item testing owner, responsible for testing and verifying work items.
develop_owner	UserEntity object	Definition Work item development owner, responsible for developing and implementing work items.
processing_owner	UserEntity object	Definition Work item processing owner, responsible for the current processing phase of the work item.
fixed_owner	UserEntity object	Definition Work item fixing owner, responsible for fixing work item problems.
researchanddevelop_owner	UserEntity object	Definition Work item R&D owner, responsible for the research and development of work items.
analyse_owner	UserEntity object	Definition Work item analysis owner, responsible for requirement analysis and technical analysis of work items.
plan_start_date	String	Definition Planned start time. Planned start date of a work item, which is used for project progress management and scheduling. Range The value is a timestamp string of 11 to 19 characters, in milliseconds.
expect_delivery_time	String	Definition Expected completion time. Expected delivery date of a work item, which is used to track whether the work item is completed on time. Range The value is a timestamp string of 11 to 19 characters, in milliseconds.
plan_test_end_date	String	Definition Planned test end time. Planned test completion date of a bug work item, which is used to track the test progress after the bug is fixed. Range The value is a timestamp string of 11 to 19 characters, in milliseconds.
severity	String	Definition Severity of a bug work item, which is used to evaluate the impact scope and fixing priority of the bug. Range Critical: Severe impacts such as system breakdown and data loss. Major: Major functions cannot be used. Minor: Minor functions are abnormal, and alternative solutions are available. Suggestion: GUI optimization and suggestion issues.
promised	String	Definition Commitment status. Indicates whether a work item of type RR is committed for delivery. Range yes: committed no: not committed
recipient	Array of UserEntity objects	Definition Receiver. The owner of an RR work item, responsible for analyzing and converting requirements. Range N/A
sys_no_develop_reason	String	Definition Reason why an RR work item does not need to be developed. Range 0 to 50,000 characters.
val_feature	String	Definition Value feature. Description of the business value feature corresponding to the SF/FE work item, which is used to associate business value with technical implementation. Range yes no
function_scene	String	Definition Function scenario. Function application scenario description of SF/FE work items, which describes the application scenarios and user stories of the feature. Range 0 to 512 characters.

**Table 11** LabelEntity
Parameter	Type	Description
id	String	Definition Label ID, which is the value of id in the response body returned by calling the API for querying the label list. Range A string of 18 to 19 digits.
category_types	Array of strings	Definition Code of the work item type to which a label belongs.
label_type	String	Definition Type of the work item to which the label belongs, corresponding to the type field of the work item. The options are as follows. Range raw requirement feature (system feature) requirement (R&D requirement) task bug
color	String	Definition Label RGB color. Range The available color codes and their descriptions are as follows: #86CAFF: light sky blue #6DDEBB: aquamarine #A6DD82: light green #FAC20A: golden yellow #FA9841: sandy orange #F66F6A: light coral #F3689A: pink #A97AF8: medium purple #71757F: slate gray #5E7CE0: soft blue #207AB3: steel blue #169E6C: sea green #6CA83B: olive green #B58200: dark golden yellow #B54E04: burnt orange #B02121: dark red #AD215B: dark pink #572DB3: deep violet #4F4F4F: dark gray #3C51A6: indigo blue
title	String	Definition Label title. Range N/A

**Table 12** FieldCodeValuePair
Parameter	Type	Description
code	String	Definition Code of a custom field of a work item. Obtain the value from the Querying Field Templates API. The value is code in the response body. Range N/A
value	String	Definition Custom field value of a work item. Range N/A

**Table 13** UserEntity
Parameter	Type	Description
id	String	Definition User ID. Obtain it by calling the API for querying project members. The value of id in the response message body is the user ID. Range N/A
name	String	Definition Username. Range 2 to 64 characters.
nick_name	String	Definition User alias. Range 2 to 30 characters

Status code: 400

**Table 14** Response body parameters
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

This API is used to create R&D requirements in batches.

POST https://{endpoint}/v2/ipdprojectservice/projects/8e70d806a8f04d018ea6af6b6ffe7b96/issues/batch

[ {
  "ir2rr" : "956559072707911681",
  "category" : "IR",
  "category_layer_id" : "10002",
  "submitted_by" : [ {
    "id" : "a360371833bf4c558f796fd707b44daf"
  }, {
    "id" : "a360371833bf4c558f796fd707b44dwf"
  } ],
  "description" : "<p>[Requirement background]</p><p><br></p>[Requirement value]</p> <p><br></p><p>[Requirement details]</p>",
  "title" : "IR-18-Breakdown",
  "assignee" : {
    "id" : "a360371833bf4c558f796fd707b44daf"
  },
  "priority" : "Medium",
  "plan_pi" : "1273201979687350273",
  "plan_end_date" : "1706630400000",
  "business_domain" : "software",
  "assigned_cc" : [ {
    "id" : "a360371833bf4c558f796fd707b44daf"
  } ],
  "custom_fields" : [ {
    "code" : "done_ratio",
    "value" : ""
  }, {
    "code" : "c7073388365101674496",
    "value" : "881467547473321986"
  }, {
    "code" : "c7148504958125613056",
    "value" : ""
  }, {
    "code" : "module",
    "value" : ""
  }, {
    "code" : "c7148512434669625344",
    "value" : "956591616891461634"
  } ]
} ]

Example Responses

Status code: 200

{
  "status" : "success",
  "result" : [ {
    "category" : "IR",
    "id" : "974703074900615168",
    "title" : "IR-18-Breakdown",
    "description" : "<p>[Requirement background]</p><p><br></p>[Requirement value]</p> <p><br></p><p>[Requirement details]</p>",
    "type" : "requirement",
    "number" : "IR20240313680650",
    "project_id" : "8e70d806a8f04d018ea6af6b6ffe7b96",
    "status" : "Start",
    "state" : "Working",
    "assignee" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account 123"
    },
    "assigned_cc" : [ {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account 123"
    } ],
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account 123"
    },
    "created_time" : "1710316922000",
    "modified_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account 123"
    },
    "modified_time" : "1710316922000",
    "workload" : "20.0",
    "tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
    "status_modified_time" : "1710316922000",
    "custom_fields" : [ {
      "code" : "c7073388365101674496",
      "value" : "881467547473321986"
    }, {
      "code" : "c7148512434669625344",
      "value" : "956591616891461634"
    } ],
    "need_break" : "yes",
    "break_status" : "undecomposed",
    "priority" : "Medium",
    "related_network_security" : "no",
    "business_domain" : "software",
    "plan_pi" : "",
    "no_break_reason" : "",
    "submitted_by" : [ {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account 123"
    }, null ],
    "ir2rr" : "956559072707911681"
  } ]
}

Status code: 400

{
  "error_code" : "PM.02174103",
  "error_msg" : "No permission."
}

Status Codes

Status Code	Description
200	OK
400	Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

Error Codes

See Error Codes.

Parent topic: IPD Work Item Management

Previous topic: Querying the Work Item List

Next topic: Querying Work Item Details V2