创建模块 - CreateIpdModule

功能介绍

创建模块

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
codeartsreq:configuration:create	Write	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

POST /v1/ipdprojectservice/projects/{project_id}/modules

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目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	参数解释：返回状态。取值范围： success：响应成功 error：响应失败
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 取值范围：不涉及

请求示例

创建子模块

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

{
  "description" : "11111222",
  "display_value" : "API-M2-P-01",
  "parent_id" : 1030206424665337900,
  "assignee" : "a360371833bf4c558f796fd707b44daf"
}

响应示例

状态码：200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "id" : "1030874468408406016",
    "created_by" : "a360371833bf4c558f796fd707b44daf",
    "value" : "1030874468408406016"
  }
}