Create or Update Menu Group


创建或修改菜单组。

请求格式


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

请求参数(URI)


名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

OU ID。如何获取 orgId 信息 >>

请求参数(Body)


名称

必需/可选

数据类型

描述

menuGroupId

可选

String

菜单组 ID。若为修改菜单组,必须填写菜单组 ID。若为新建菜单组,需留空。

appId

必需

String

应用的 Access Key。如何获取 Access Key >>

name

可选

String

菜单组名称。若为新建菜单组或修改已有菜单组的名称,需填写菜单组名称。若为修改菜单组的其它内容,需留空。

menuIds

可选

List <string>

菜单列表。创建菜单组时,若为空则创建一个空的菜单组。修改菜单组时,若为空则清除菜单组中的菜单,若指定菜单 ID,将清空菜单组内的已有菜单。

响应参数


名称

数据类型

描述

id

String

新建或修改的菜单组 ID。

name

String

新建或修改后的菜单组名称。

错误码


代码

描述

31400

OU ID 或菜单组名称为空

31403

当前应用无权编辑菜单组

31404

可能原因如下:

  • OU ID 或菜单组名称不存在

  • OU 无权访问应用或菜单组

31408

菜单组名称已存在

示例

请求示例


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

返回示例


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