Get Application Menu Group


Get the menu groups of an application.

Request Format


GET https://{apigw-address}/app-portal-service/v2.3/app/menuGroup/list

Request Parameters (URI)


Name

Location (Path/Query)

Required/Optional

Data Type

Description

orgId

Query

Required

String

OU ID. How to get orgId >>

appId

Query

Required

String

The access key of the application. How to get Access Key >>

Response Parameters


Name

Data Type

Description

menuGroups

MenuGroupDTO Struct

Menu group list. MenuGroupDTO Struct >>

MenuGroupDTO Struct


Name

Data Type

Description

id

String

Menu group ID.

name

String

Menu group name.

menuIds

Array

The IDs of menus in the menu group.

Error Codes


Error Code

Description

31400

OU ID is required.

31404

OU ID does not exists, or OU has no permission to access the application.

Samples

Request Sample


url: https://{apigw-address}/app-portal-service/v2.3/app/menuGroup/list?orgId=your_org_id&appId=your_access_key
method: GET

Return Sample


{
  "code": 0,
  "message": "OK",
  "data": [
            {
                "id": "your_menu_group_id_1",
                "name": "your_menu_group_name_1",
                "menuIds": [
                    "your_menu_id_1",
                    "your_menu_id_2",
                ]
            },
            {
                "id": "your_menu_group_id_2",
                "name": "your_menu_group_name_2",
                "menuIds": []
            }
        ]

}