> 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/api-en/back-office-api-reference/system-bo-api/favorites-management.md).

# Favorites Management

## Modify/Delete Favorites Group List

> \## Function Description\
> \* Modifies and deletes the favorites list.\
> \---\
> \## Detailed Description\
> \* The usage status of a menu selected in the favorites list can be modified.\
> \* A menu removed from the favorites list is no longer displayed in the My Menu tab of the LNB.\
> \---\
> \## Revision History\
> \* Release v2.00\_240613: Updated the system modification date/time to the current time upon modification<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestStUserFvtInfo":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/StUserFvtInfo"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/StUserFvtInfo"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/StUserFvtInfo"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/StUserFvtInfo"}}}},"StUserFvtInfo":{"type":"object","description":"User Favorites Entity","properties":{"userId":{"type":"string","description":"User ID"},"useYn":{"type":"string","description":"Usage Status"},"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"sortSeq":{"type":"integer","format":"int64","description":"Authorization Target Sequence No."}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/system/userFavoriteMenuMgmt/saveUserFavoriteMenu":{"post":{"tags":["Favorites Management"],"summary":"Modify/Delete Favorites Group List","description":"## Function Description\n* Modifies and deletes the favorites list.\n---\n## Detailed Description\n* The usage status of a menu selected in the favorites list can be modified.\n* A menu removed from the favorites list is no longer displayed in the My Menu tab of the LNB.\n---\n## Revision History\n* Release v2.00_240613: Updated the system modification date/time to the current time upon modification\n","operationId":"saveUserFavoriteMenu","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestStUserFvtInfo"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Favorites Group List

> \## Function Description\
> \* Retrieves the favorites list.\
> \---\
> \## Detailed Description\
> \* User ID is required.\
> \* If a menu name is entered on the screen, the count of the favorites list with that menu name is returned.\
> \---\
> \## Revision History\
> \* Release v2.00\_240613: Added sort by modification date/time after sort order in the sort condition<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserFavoriteMenuRequest":{"type":"object","description":"Favorites Registration Request DTO","properties":{"userId":{"type":"string","description":"User ID"},"rtGrpNo":{"type":"string","description":"Authorization Group No."},"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"sortSeq":{"type":"integer","format":"int64","description":"Sort Order"},"rtTgtNm":{"type":"string","description":"Menu Name"},"useYn":{"type":"string","description":"Usage Status"}}},"ResponseRealGridListResponseUserFavoriteMenuResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/RealGridListResponseUserFavoriteMenuResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseUserFavoriteMenuResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/UserFavoriteMenuResponse"}}}},"UserFavoriteMenuResponse":{"type":"object","description":"Favorites Management Retrieval Response DTO","properties":{"rtGrpNo":{"type":"string","description":"Authorization Group No."},"rtTgtSeq":{"type":"string","description":"Permission Group Sequence No."},"sysResDtm":{"type":"string","format":"date-time","description":"Registration Date/Time"},"sortSeq":{"type":"integer","format":"int64","description":"Sort Order"},"rtTgtNm":{"type":"string","description":"Menu Name"},"useYn":{"type":"string","description":"Usage Status"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/system/userFavoriteMenuMgmt/getUserFavoriteMenuList":{"get":{"tags":["Favorites Management"],"summary":"Retrieve Favorites Group List","description":"## Function Description\n* Retrieves the favorites list.\n---\n## Detailed Description\n* User ID is required.\n* If a menu name is entered on the screen, the count of the favorites list with that menu name is returned.\n---\n## Revision History\n* Release v2.00_240613: Added sort by modification date/time after sort order in the sort condition\n","operationId":"getUserFavoriteMenuList","parameters":[{"name":"userFavoriteMenuRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/UserFavoriteMenuRequest"}},{"name":"rtTgtNm","in":"query","description":"Menu Name","schema":{"type":"String"}},{"name":"userId","in":"query","description":"User ID","schema":{"type":"String"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseUserFavoriteMenuResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
