更新模块 - UpdateIpdModule
功能介绍
更新指定模块信息，支持更新模块名称、父模块、描述和责任人。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v1/ipdprojectservice/projects/{project_id}/modules/{module_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 项目32位ID，项目唯一标识。通过查询IPD项目列表获取，响应消息体中的id字段的值就是项目ID。 约束限制： 不涉及。 取值范围： 32个字符，由英文字母和数字组成。 默认取值： 不涉及。 |
| module_id | 是 | String | 参数解释： 模块唯一标识ID。 约束限制： 不涉及。 取值范围： 18~19个字符的数字字符串。 默认取值： 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| description | 否 | String | 参数解释： 模块描述信息。 约束限制： 不涉及。 取值范围： 最大255个字符。 默认取值： 不涉及 |
| display_value | 否 | String | 参数解释： 模块名称。 约束限制： 不涉及。 取值范围： 2~30个字符。 默认取值： 不涉及 |
| parent_id | 否 | String | 参数解释： 父模块ID，更新模块层级关系时指定新的父模块。 约束限制： 不涉及。 取值范围： 18~19个字符的数字字符串。 默认取值： 不涉及 |
| assignee | 否 | String | 参数解释： 模块责任人ID。 约束限制： 不涉及。 取值范围： 32个字符。 默认取值： 不涉及 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释： 返回状态。 取值范围： |
| message | String | 参数解释： 返回消息。 取值范围： 不涉及。 |
| result | UpdateModuleResultVO object | 参数解释： 更新模块返回结果。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释： 更新后的模块ID。可以通过查询模块树形列表获取，响应消息体中的id字段的值就是模块ID。 取值范围： 18~19个字符的数字字符串。 |
| modified_by | String | 参数解释： 模块最近修改人ID。 取值范围： 32个字符。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述，对error_code的补充解释。 取值范围： 不涉及。 |
请求示例
PUT https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/modules/1030877439598833664
{
"description" : "这是一个更新后的模块描述",
"display_value" : "更新后的模块名称",
"parent_id" : "0987654321fedcba0987654321fedcba",
"assignee" : "fedcba0987654321fedcba0987654321"
} 响应示例
状态码：400
请求失败的响应。例如无操作权限、项目不存在。
{
"error_code" : "PM.02174103",
"error_msg" : "无操作权限"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新模块成功 |
| 400 | 请求失败的响应。例如无操作权限、项目不存在。 |
错误码
请参见错误码。
