Updated on 2025-09-10 GMT+08:00

Querying Module Settings

Function

This API is used to query module settings.

Calling Method

For details, see Calling APIs.

URI

GET /v2/module/modules

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

The value must contain 32 characters. Digits and letters are allowed.

Value range:

N/A

Default value:

N/A

page_no

No

Integer

Definition:

Page index.

Constraints:

N/A

Value range:

Minimum value: 0. Maximum value: 9,999,999,999.

Default value:

N/A

page_size

No

Integer

Definition:

Page size.

Constraints:

N/A

Value range:

Minimum value: 0. Maximum value: 9,999,999,999.

Default value:

N/A

limit

No

Integer

Definition:

Number of records displayed on each page.

Constraints:

N/A

Value range:

Minimum length: 1 character. Maximum length: 10 characters.

Default value:

10

offset

No

Integer

Definition:

Pagination index. The offset is an integer multiple of limit. For example, if the value of offset is 0, the return starts from the first record. If the value of offset is 10, the return starts from the eleventh record.

Constraints:

N/A

Value range:

Minimum value: 0. Maximum value: 10,000.

Default value:

Default value: 0.

search

No

String

Definition:

Query index set for the module.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

Minimum length: 10 characters. Maximum length: 32,768 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

result object

Definition: returned result.

status

String

Definition:

Returned status.

Value range:

N/A

Table 4 result

Parameter

Type

Description

total_count

Integer

Definition:

Number of modules.

Value range:

N/A

modules

Array of modules objects

Definition:

Modules.

Table 5 modules

Parameter

Type

Description

id

Integer

Definition:

Module ID in module management.

Value range:

N/A

name

String

Definition:

Name of a module in module management.

Value range:

N/A

owner

Object

Definition:

Module owner.

Value range:

N/A

description

String

Definition:

Module description.

Value range:

N/A

project

project object

Definition:

Current project information.

deepth

Integer

Definition:

Parent-child relationship of a module.

Value range:

N/A

path

String

Definition:

Path of a module.

Value range:

N/A

path_name

String

Definition:

Path name of a module.

Value range:

N/A

is_match

Boolean

Definition:

Check whether the module information is found.

Value range:

true (found)

false (not found)

child

Array of strings

Definition:

Sub-module list of a module.

Value range:

N/A

is_parent

Boolean

Definition:

Whether there is a sub-module.

Value range:

0 (no sub-modules)

1 (with sub-modules)

Table 6 project

Parameter

Type

Description

id

Integer

Definition:

ID of the current project.

Value range:

N/A

Example Requests

{endpoint}/v2/module/modules?project_id=5192de5eb435430c8cd41c6ae6028848&limit=1&offset=10&search=&_=1753185098033

Example Responses

Status code: 200

The query module interface setup response was successful.

{
  "result" : {
    "total_count" : 5,
    "modules" : [ {
      "id" : 885859,
      "name" : "Promotion management",
      "owner" : {
        "id" : 4091,
        "name" : "devcloud_devcloud_s00404480_01",
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "nick_name" : "Sam 1"
      },
      "description" : "Promotion management",
      "project" : {
        "id" : 35138974
      },
      "deepth" : 1,
      "path" : "885859",
      "path_name" : "Promotion management",
      "is_match" : true,
      "child" : [ ],
      "is_parent" : false
    }, {
      "id" : 885858,
      "name" : "Accessory management",
      "owner" : {
        "id" : 4091,
        "name" : "devcloud_devcloud_s00404480_01",
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "nick_name" : "Sam 1"
      },
      "description" : "Accessory management",
      "project" : {
        "id" : 35138974
      },
      "deepth" : 1,
      "path" : "885858",
      "path_name" : "Accessory management",
      "is_match" : true,
      "child" : [ ],
      "is_parent" : false
    }, {
      "id" : 885857,
      "name" : "Order management",
      "owner" : {
        "id" : 4091,
        "name" : "devcloud_devcloud_s00404480_01",
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "nick_name" : "Sam 1"
      },
      "description" : "Order management",
      "project" : {
        "id" : 35138974
      },
      "deepth" : 1,
      "path" : "885857",
      "path_name" : "Order management",
      "is_match" : true,
      "child" : [ ],
      "is_parent" : false
    }, {
      "id" : 885856,
      "name" : "Membership management",
      "owner" : {
        "id" : 4091,
        "name" : "devcloud_devcloud_s00404480_01",
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "nick_name" : "Sam 1"
      },
      "description" : "Membership management",
      "project" : {
        "id" : 35138974
      },
      "deepth" : 1,
      "path" : "885856",
      "path_name" : "Membership management",
      "is_match" : true,
      "child" : [ ],
      "is_parent" : false
    }, {
      "id" : 885855,
      "name" : "Store network",
      "owner" : {
        "id" : 4091,
        "name" : "devcloud_devcloud_s00404480_01",
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "nick_name" : "Sam 1"
      },
      "description" : "Store network",
      "project" : {
        "id" : 35138974
      },
      "deepth" : 1,
      "path" : "885855",
      "path_name" : "Store network",
      "is_match" : true,
      "child" : [ ],
      "is_parent" : false
    } ]
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

The query module interface setup response was successful.

Error Codes

See Error Codes.