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

Creating a Module

Function

This API is used to create a module under a project. Sub-modules can be created.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsreq:configuration:create	Write	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

POST /v1/ipdprojectservice/projects/{project_id}/modules

**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 body parameters
Parameter	Mandatory	Type	Description
description	No	String	Definition Module description. Constraints N/A Range Max. 255 characters. Default Value N/A
display_value	Yes	String	Definition Module name. Constraints N/A Range 2 to 30 characters Default Value N/A
parent_id	No	String	Definition Parent module ID, which is specified when a child module is created. Constraints N/A Range A string of 18 to 19 digits. Default Value N/A
assignee	No	String	Definition Module owner ID. If this parameter is left blank, the project administrator is used by default. Constraints N/A Range 32 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Definition Response status. Range success: The module is successfully created. error: The module fails to be created.
message	String	Definition Returned message. Range N/A
result	CreateModuleResultVO object	Definition Response for creating a module.

**Table 4** CreateModuleResultVO
Parameter	Type	Description
id	String	Definition ID of the created module. Obtain the value of this parameter using the Querying the Module Tree List API. The value of id in the response message body is the module ID. Range A string of 18 to 19 digits.
created_by	String	Definition ID of the module creator. Range 32 characters.
value	String	Definition Unique ID of a module. The value and ID of a custom module are the same. Range Max. 32 characters.

Status code: 400

**Table 5** 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

Creating a child module

POST https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/modules

{
  "description" : "11111222",
  "display_value" : "API-M2-P-01",
  "parent_id" : 1030206424665337900,
  "assignee" : "a360371833bf4c558f796fd707b44daf"
}

Example Responses