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

Updating a Module

Function

This API is used to update information about a specified module, including the module name, parent module, description, and owner.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

PUT /v1/ipdprojectservice/projects/{project_id}/modules/{module_id}

**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
module_id	Yes	String	Definition Unique module ID. Constraints N/A Range A string of 18 to 19 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	No	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 the module hierarchy is updated. Constraints N/A Range A string of 18 to 19 digits. Default Value N/A
assignee	No	String	Definition Module owner ID. 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 updated. error: Failed to update the module.
message	String	Definition Returned message. Range N/A
result	UpdateModuleResultVO object	Definition Returned result of module update.

**Table 4** UpdateModuleResultVO
Parameter	Type	Description
id	String	Definition Updated module ID. 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.
modified_by	String	Definition ID of the latest modifier of the module. Range 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

PUT https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/modules/1030877439598833664

{
  "description" : "This is an updated module description.",
  "display_value" : "Updated module name",
  "parent_id" : "0987654321fedcba0987654321fedcba",
  "assignee" : "fedcba0987654321fedcba0987654321"
}

Example Responses

Status code: 200

None

Status code: 400

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

Status Codes

Status Code	Description
200	Module updated successfully.
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 Module Management