查询模块设置
功能介绍
查询模块设置。
调用方法
请参见如何调用API。
URI
GET /v2/module/modules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。 约束限制： 32位的数字和字母组成的字符串。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
page_no |
否 |
Integer |
参数解释： 分页索引。 约束限制： 不涉及 取值范围： 最小值0，最大值9,999,999,999。 默认取值： 不涉及。 |
|
page_size |
否 |
Integer |
参数解释： 分页大小。 约束限制： 不涉及。 取值范围： 最小值0，最大值9,999,999,999。 默认取值： 不涉及。 |
|
limit |
否 |
Integer |
参数解释： 条数，每页显示查询的数量。 约束限制： 不涉及。 取值范围： 最小长度：1，最大长度：10。 默认取值： 10。 |
|
offset |
否 |
Integer |
参数解释： 分页索引，偏移量，offset是limit的整数倍数。例如，offset为0表示从第一个记录开始，offset为10表示从第11个记录开始。 约束限制： 不涉及。 取值范围： 最小值：0，最大值：10000。 默认取值： 缺省值：0。 |
|
search |
否 |
String |
参数解释： 模块设置的搜索索引。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 最小长度：10，最大长度：32768。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
result object |
参数解释： 返回结果。 |
|
status |
String |
参数解释： 返回状态。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
参数解释： 模块设置的模块数量。 取值范围： 不涉及。 |
|
modules |
Array of modules objects |
参数解释： 模块设置。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释： 模块管理中的模块id。 取值范围： 不涉及。 |
|
name |
String |
参数解释： 模块管理中的模块名字。 取值范围： 不涉及。 |
|
owner |
Object |
参数解释： 模块设置的负责人信息。 取值范围： 不涉及。 |
|
description |
String |
参数解释： 模块的描述信息。 取值范围： 不涉及。 |
|
project |
project object |
参数解释： 当前项目信息。 |
|
deepth |
Integer |
参数解释： 模块的父子关系层级。 取值范围： 不涉及。 |
|
path |
String |
参数解释： 模块设置的路径。 取值范围： 不涉及。 |
|
path_name |
String |
参数解释： 模块设置的路径名字。 取值范围： 不涉及。 |
|
is_match |
Boolean |
参数解释： 是否查到模块信息。 取值范围： true（查到模块信息） false（未查到模块信息） |
|
child |
Array of strings |
参数解释： 模块的子模块列表。 取值范围： 不涉及。 |
|
is_parent |
Boolean |
参数解释： 是否有子模块。 取值范围： 0（没有子模块） 1（有子模块） |
请求示例
{endpoint}/v2/module/modules?project_id=5192de5eb435430c8cd41c6ae6028848&limit=1&offset=10&search=&_=1753185098033
响应示例
状态码：200
查询模块设置接口成功的响应。
{
"result" : {
"total_count" : 5,
"modules" : [ {
"id" : 885859,
"name" : "促销管理",
"owner" : {
"id" : 4091,
"name" : "devcloud_devcloud_s00404480_01",
"identifier" : "a360371833bf4c558f796fd707b44daf",
"nick_name" : "张三丰1"
},
"description" : "促销管理",
"project" : {
"id" : 35138974
},
"deepth" : 1,
"path" : "885859",
"path_name" : "促销管理",
"is_match" : true,
"child" : [ ],
"is_parent" : false
}, {
"id" : 885858,
"name" : "配件管理",
"owner" : {
"id" : 4091,
"name" : "devcloud_devcloud_s00404480_01",
"identifier" : "a360371833bf4c558f796fd707b44daf",
"nick_name" : "张三丰1"
},
"description" : "配件管理",
"project" : {
"id" : 35138974
},
"deepth" : 1,
"path" : "885858",
"path_name" : "配件管理",
"is_match" : true,
"child" : [ ],
"is_parent" : false
}, {
"id" : 885857,
"name" : "订单管理",
"owner" : {
"id" : 4091,
"name" : "devcloud_devcloud_s00404480_01",
"identifier" : "a360371833bf4c558f796fd707b44daf",
"nick_name" : "张三丰1"
},
"description" : "订单管理",
"project" : {
"id" : 35138974
},
"deepth" : 1,
"path" : "885857",
"path_name" : "订单管理",
"is_match" : true,
"child" : [ ],
"is_parent" : false
}, {
"id" : 885856,
"name" : "会员管理",
"owner" : {
"id" : 4091,
"name" : "devcloud_devcloud_s00404480_01",
"identifier" : "a360371833bf4c558f796fd707b44daf",
"nick_name" : "张三丰1"
},
"description" : "会员管理",
"project" : {
"id" : 35138974
},
"deepth" : 1,
"path" : "885856",
"path_name" : "会员管理",
"is_match" : true,
"child" : [ ],
"is_parent" : false
}, {
"id" : 885855,
"name" : "门店网络",
"owner" : {
"id" : 4091,
"name" : "devcloud_devcloud_s00404480_01",
"identifier" : "a360371833bf4c558f796fd707b44daf",
"nick_name" : "张三丰1"
},
"description" : "门店网络",
"project" : {
"id" : 35138974
},
"deepth" : 1,
"path" : "885855",
"path_name" : "门店网络",
"is_match" : true,
"child" : [ ],
"is_parent" : false
} ]
},
"status" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询模块设置接口成功的响应。 |
错误码
请参见错误码。
