更新时间:2025-07-21 GMT+08:00
分享

更新模块

功能介绍

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

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

正则表达式,^[A-Za-z0-9]{32}$。

取值范围

不涉及。

默认取值

不涉及。

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层

取值范围:

1,2,3

description

String

参数解释:

模块描述信息

取值范围:

不涉及

created_by

String

参数解释:

模块创建人id

取值范围:

不涉及

created_time

String

参数解释:

模块创建时间,unix时间戳,单位:毫秒

取值范围:

不涉及

modified_by

String

参数解释:

模块最近修改人id

取值范围:

不涉及

modified_time

String

参数解释:

模块最近修改时间,unix时间戳,单位:毫秒

取值范围:

不涉及

display_value

String

参数解释:

模块显示名称

取值范围:

不涉及

path_name

String

参数解释:

子模块的路径名称

取值范围:

不涉及

value

String

参数解释:

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

取值范围:

不涉及

parent_id

String

参数解释:

父模块id

取值范围:

不涉及

child_modules

Array of ModuleEntity objects

参数解释:

子模块信息

assignee

String

参数解释:

模块责任人id

取值范围:

不涉及

请求示例

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

{
  "description" : "这是一个更新后的模块描述",
  "display_value" : "更新后的模块名称",
  "parent_id" : "0987654321fedcba0987654321fedcba",
  "assignee" : "fedcba0987654321fedcba0987654321"
}

响应示例

状态码:200

OK

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档