Deleting a module
Function
This API is used to delete a specified module and all its sub-modules.
Calling Method
For details, see Calling APIs.
Authorization Information
No identity policy-based permission required for calling this API.
URI
DELETE /v1/ipdprojectservice/projects/{project_id}/modules/{module_id}
| 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
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| status | String | Definition Response status. Range |
| message | String | Definition Returned message. Range N/A |
| result | DeleteModuleResultVO object | Definition Result of deleting a module. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition ID of the deleted module. 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
| 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
Deleting a Module
DELETE https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/modules/1030877439598833664 Example Responses
Status code: 200
None
Status code: 400
{
"error_code" : "PM.02174103",
"error_msg" : "No permission."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Module deleted. |
| 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.
What is your overall rating for this page?
Thank 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