文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD模块管理/ 更新模块
更新时间：2024-11-30 GMT+08:00
查看PDF
分享

更新模块

功能介绍

更新模块，支持更新标题，父模块，描述，责任人

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目Id

module_id

是

String

模块Id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

description

否

String

模块描述信息，最长支持255个字符

display_value

是

String

模块名称。最短2个字符，最长30个字符

parent_id

是

String

创建子模块，更新模块A作为模块B的子模块时必填。值为父模块的Id

assignee

否

String

模块责任人Id

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

请求状态

message

String

请求失败信息

result

ModuleEntity object

模块详情
表4 ModuleEntity

参数

参数类型

描述

id

String

模块id

sequence

String

模块顺序值。double类型

level

Integer

模块层级，最多3层

description

String

模块描述信息

created_by

String

模块创建人id

created_time

String

模块创建时间

modified_by

String

模块最近修改人id

modified_time

String

模块最近修改时间

display_value

String

模块显示名

path_name

String

子模块的路径名

value

String

模块唯一标识，自定义模块value和id项目

parent_id

String

父模块id

child_modules

Array of ModuleEntity objects

子模块

assignee

String

模块责任人id

请求示例

{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/modules/1030877439598833664

{
  "display_value" : "API-M2-aaa"
}

响应示例

状态码： 200

OK

{
  "status" : "success",
  "message" : null,
  "result" : {
    "id" : "1030877439598833664",
    "modified_by" : "a360371833bf4c558f796fd707b44daf"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： IPD模块管理

相关文档