Create or Update Menu Group¶

Create or update a menu group.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.3/app/menuGroup/createOrUpdate

Request Parameters (Query)¶

Name	Mandatory/Optional	Data Type	Description
orgId	Mandatory	String	OU ID.

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
menuGroupId	Optional	String	Menu group ID. Enter the ID of the menu group you want to update, or leave it blank to create a menu group.
appId	Mandatory	String	Application ID.
name	Optional	String	Menu group name. When you create a menu group, the parameter is mandatory. When you update a menu group, enter the new menu group name if you want to rename the menu group.
menuIds	Optional	List <string>	Menu list. When you create a menu group, leave it blank to create an empty menu group. When you update a menu group, leave it blank to remove all menus in the menu group.

Response Parameters¶

Name	Data Type	Description
data	MenuGroupDTO Struct	The information of the menu group you create or update.

MenuGroupDTO Struct¶

Name	Data Type	Description
id	String	The ID of the menu group you create or update.
name	String	The name of the menu group.

Error Codes¶

Error Code	Description
31400	OU ID and menu group name and required.
31403	The service account has no permission to edit menu group.
31404	Possible reasons are: - OU ID or menu group name does not exist. - OU has no permission to access the application or menu group.
31408	The menu group name already exists.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.3/app/menuGroup/createOrUpdate
method: POST
{
  "menuGroupId": "your_menu_group_id",
  "appId": "your_app_id",
  "name": "your_app_name",
  "menuIds": [
    "your_menu_id_1",
    "your_menu_id_2",
    "your_menu_id_3",
    "your_menu_id_4",
  ]
}

Return Sample¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "id": "your_menu_group_id",
    "name": "your_menu_group_name"
  }
}