添加自定义工作项模块
功能介绍
添加自定义工作项模块。
调用方法
请参见如何调用API。
URI
POST /v2/module/modules
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
参数解释: 这是一个描述字段,用来提供关于该项目或任务的更多细节。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
name |
否 |
String |
参数解释: 工作项模块的名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
owner |
否 |
String |
参数解释: 模块的负责人数字id,通过获取指定项目的成员用户列表接口获取,响应消息体中的user_num_id字段的值就是模块的负责人数字id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_id |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
parent_num_id |
否 |
String |
参数解释: 用于表示父级任务的唯一标识,通过查询模块设置接口获取,响应消息体中的modules里面的id的值就是模块ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 返回的结果。 |
status |
String |
参数解释: 结果状态。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
description |
String |
参数解释: 模块的描述。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 模块的id。 取值范围: 不涉及。 |
name |
String |
参数解释: 模块的名称。 取值范围: 不涉及。 |
owner |
owner object |
参数解释: 模块的拥有者。 |
project |
project object |
参数解释: 项目信息。 |
path |
String |
参数解释: 模块的路径。 取值范围: 不涉及。 |
path_name |
String |
参数解释: 模块路径的名称。 取值范围: 不涉及。 |
请求示例
POST http://{endpoint}/v2/module/modules?_=1753684289689 { "description" : "", "name" : "阿萨达", "owner" : "4091", "project_id" : "5192de5eb435430c8cd41c6ae6028848", "parent_num_id" : "" }
响应示例
状态码:200
添加自定义工作项模板接口成功的响应。
{ "result" : { "module" : { "description" : "", "id" : 886637, "name" : "阿萨达", "owner" : { "id" : 4091, "name" : "devcloud_devcloud_s00404480_01", "identifier" : "a360371833bf4c558f796fd707b44daf", "nick_name" : "张三丰1" }, "project" : { "id" : 35138974, "identifier" : "5192de5eb435430c8cd41c6ae6028848", "name" : "DevOps全流程示例项目XXXX", "type" : "scrum" }, "path" : "886637", "path_name" : "阿萨达" } }, "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
添加自定义工作项模板接口成功的响应。 |
错误码
请参见错误码。