> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api-guide/api-guides-en/back-office/system-bo/menu-management.md).

# Menu Management

The Menu Management service provides functionality to efficiently manage all menus, their sub-menus, and permission menus within the admin system. Users can register new permission menus or modify the usage status of permission menus.

***

## Key Features

* **Menu Information Management**
  * Systematically manages all menu information and permissions in the admin system.
  * When registering a sub-menu, users can grant permission menus for buttons, requests, and more, and modify their usage status.
  * Menus are classified into BO (Back Office), PO (Partner Office), and CC (Customer Center) and can be searched by usage status.
* **Admin Main Menu**
  * When a user accesses the admin page, they can view the top menu and the sub-menus of that menu as a left-side menu.
  * Users can register a specific menu as a favorite for convenient management of frequently used menus.
* **Common Menu**
  * When a user accesses a screen, checks the permission for that URL and looks up access eligibility for cases that include personal information.
  * Registers the user's usage log to manage access history.

***

## Process Definition\_Menu Information Management

Manages menus and permissions within the admin system.

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2Fp8hBdSM41eOBBvNQP0dc%2F%E1%84%86%E1%85%A6%E1%84%82%E1%85%B2.png?alt=media&#x26;token=5269afe8-812d-4bfe-9a2e-fda76ae23552" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Menu Tree List Lookup

Looks up all registered menus in a tree structure. After the lookup, looks up the detail information and sub-menu information for the first value.
{% endstep %}

{% step %}

### Menu Detail Information Registration/Modification

You can register or modify detail information for the selected menu.
{% endstep %}

{% step %}

### Sub-Menu Save

Registers, modifies, and deletes sub-menus for the selected menu.

* When deleting a menu, checks whether sub-menus exist under the selected menu and whether valid permission targets exist for that menu; if so, deletion cannot proceed.
* Modifies the usage status of sub-menus.
  {% endstep %}

{% step %}

### Menu Permission Usage Status Modification

Modifies the usage status for the selected menu.
{% endstep %}
{% endstepper %}

***

## Process Definition\_Common and Admin Main Management

Manages the key common and Admin Main features through admin system login.

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2F8xfLhAWu5z7MllBsYoXM%2F%E1%84%8B%E1%85%A5%E1%84%83%E1%85%B3%E1%84%86%E1%85%B5%E1%86%AB.png?alt=media&#x26;token=73747557-f911-4051-b2b2-283df3a118a0" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Top Menu Lookup

Looks up the registered menus upon admin system login.

* After looking up the top menu, automatically looks up the sub-screen menu for the first top menu.
* Looks up the logged-in user's favorite menus.
  {% endstep %}

{% step %}

### Favorite Menu Duplicate Check/Registration

Users register their desired menu as a favorite. When registering, checks whether the menu is already registered.
{% endstep %}

{% step %}

### URL Permission Lookup

When a user enters a screen, checks usage permission via the screen URL.

* Checks whether the screen contains personal information.
* Saves the usage log for the screen URL.
  {% endstep %}
  {% endstepper %}

***

## API Function List\_Admin Main

<table><thead><tr><th width="107.888916015625">API</th><th width="332.2222900390625">Description</th><th width="92.4444580078125" align="center">Server</th><th width="89.111083984375" align="center">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Top Menu Lookup</td><td>Looks up the top menu of the admin system.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=getTopMenuList">🔗View API ></a></td></tr><tr><td>Left Menu Lookup</td><td>Looks up the left menu of the admin system.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=getLeftMenuList">🔗View API ></a></td></tr><tr><td>Favorites Lookup</td><td>Looks up the admin system user's favorites list.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=getFavoriteMenu">🔗View API ></a></td></tr><tr><td>Favorite Menu Registration</td><td>Registers the admin system user's favorite menu.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=registUserFavoriteMenu">🔗View API ></a></td></tr><tr><td>Favorite Menu Duplicate Check</td><td>Checks whether the menu is already registered when registering a favorite menu.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=checkDuplicateUserFavoriteMenu">🔗View API ></a></td></tr></tbody></table>

***

## API Function List\_Common

<table><thead><tr><th width="143.4444580078125">API</th><th width="303.2222900390625">Description</th><th width="94.6666259765625" align="center">Server</th><th width="89.111083984375" align="center">Method</th><th>Notes</th></tr></thead><tbody><tr><td>URL Permission Lookup</td><td>Looks up the permission for a screen URL.</td><td align="center">BO</td><td align="center">POST</td><td><a href="http://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B3%B5%ED%86%B5&#x26;path=getAdminGroups">🔗View API ></a></td></tr><tr><td>Permission Information and<br>Personal Information Presence Lookup for the Accessed URL</td><td>Looks up permission information and whether personal information is present for the accessed URL.</td><td align="center">BO</td><td align="center">GET</td><td><a href="http://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B3%B5%ED%86%B5&#x26;path=getRtTgtSeqByStRtTgtBase">🔗View API ></a></td></tr><tr><td>Permission Target<br>Usage Log Registration</td><td>Registers the permission target usage log for the accessed screen URL.</td><td align="center">BO</td><td align="center">POST</td><td><a href="http://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B3%B5%ED%86%B5&#x26;path=insertStRtTgtBaseLog">🔗View API ></a></td></tr></tbody></table>

***

## API Function List\_Menu Information Management

<table><thead><tr><th width="111.2222900390625">API</th><th width="381.2222900390625">Description</th><th width="94.6666259765625" align="center">Server</th><th width="90.22216796875" align="center">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Menu Tree List Lookup</td><td>Looks up the entire menu of the admin system as a tree-structured list.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getMenuMgmtTreeList">🔗View API ></a></td></tr><tr><td>Menu Detail Information Lookup</td><td>Looks up the detail information for the menu selected in the tree-structured list.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getMenuInfo">🔗View API ></a></td></tr><tr><td>Sub-Menu List Count Lookup</td><td>Looks up the sub-menu list count for the menu selected in the tree-structured list.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getSubMenuListCount">🔗View API ></a></td></tr><tr><td>Sub-Menu List Lookup</td><td>Looks up the sub-menu list for the menu selected in the tree-structured list.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getSubMenuList">🔗View API ></a></td></tr><tr><td>Menu<br>Detail Information<br>Registration</td><td>Registers detail information for the parent menu.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=registMenuInfo">🔗View API ></a></td></tr><tr><td>Menu<br>Detail Information<br>Modification</td><td>Modifies detail information for the parent menu.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=modifyMenuInfo">🔗View API ></a></td></tr><tr><td>Sub-Menu<br>Existence<br>Check</td><td>When deleting a menu, checks whether sub-menus exist.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getSubMenuCheck">🔗View API ></a></td></tr><tr><td>Valid Permission Target Check</td><td>When deleting a menu, checks whether a valid permission target exists for that menu.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getRtInfoCheck">🔗View API ></a></td></tr><tr><td>Sub-Menu Save</td><td>Saves the sub-menu.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=saveSubMenu">🔗View API ></a></td></tr><tr><td>Menu Permission<br>Usage Status<br>Modification</td><td>Modifies the usage status for the parent menu.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=modifyMenuRight">🔗View API ></a></td></tr><tr><td>Individual Permission<br>Usage Status<br>Modification</td><td>Modifies the usage status for the sub-menu.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=saveMenuRightIndiv">🔗View API ></a></td></tr></tbody></table>

***