> 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/menu-information-management.md). # Menu Information Management ## Retrieve Menu Detail Information > \## Function Description\ > \* Retrieves the detail information of the menu clicked on the screen.\ > \---\ > \## Detailed Description\ > \* Retrieves the detail information of the menu clicked on the screen.
```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":{"AuthTargetBase":{"type":"object","description":"Authorization Target Basic Info","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call Method"},"useYn":{"type":"string","description":"Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/menuMgmt/{rtTgtSeq}":{"get":{"tags":["Menu Information Management"],"summary":"Retrieve Menu Detail Information","description":"## Function Description\n* Retrieves the detail information of the menu clicked on the screen.\n---\n## Detailed Description\n* Retrieves the detail information of the menu clicked on the screen.\n","operationId":"getMenu","parameters":[{"name":"rtTgtSeq","in":"path","description":"Authorization Target Sequence No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AuthTargetBase"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Save Submenu List > \## Function Description\ > \* Registers, modifies, and deletes the menu list.\ > \---\ > \## Detailed Description\ > \* Required Value List\ > \* Save\ > \* Permission Target Name\ > \* Permission Target Type Code\ > \* Sort Order\ > \* Usage Status\ > \* System Type Code\ > \* Parent Permission Target Sequence No.\ > \* System Registrant ID\ > \* System Modifier ID\ > \* Modify\ > \* Permission Target Sequence No.\ > \* Permission Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Registrant ID\ > \* System Modifier ID\ > \* Delete\ > \* Permission Target Sequence No.
```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":{"RealGridCUDRequestAuthTargetBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/AuthTargetBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/AuthTargetBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/AuthTargetBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/AuthTargetBase"}}}},"AuthTargetBase":{"type":"object","description":"Authorization Target Basic Info","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call Method"},"useYn":{"type":"string","description":"Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}}},"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/menuMgmt/{rtTgtSeq}":{"post":{"tags":["Menu Information Management"],"summary":"Save Submenu List","description":"## Function Description\n* Registers, modifies, and deletes the menu list.\n---\n## Detailed Description\n* Required Value List\n * Save\n * Permission Target Name\n * Permission Target Type Code\n * Sort Order\n * Usage Status\n * System Type Code\n * Parent Permission Target Sequence No.\n * System Registrant ID\n * System Modifier ID\n * Modify\n * Permission Target Sequence No.\n * Permission Target Name\n * Sort Order\n * Usage Status\n * System Registrant ID\n * System Modifier ID\n * Delete\n * Permission Target Sequence No.\n","operationId":"saveMeuList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestAuthTargetBase"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Modify Menu Detail Information > \## Function Description\ > \* Modifies the detail information of a menu.\ > \---\ > \## Detailed Description\ > \* Required value list\ > \* Authorization Target Type Code\ > \* Authorization Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Modifier ID\ > \* Authorization Target Sequence No.\ > \* Customer Info Included Status\ > \* Popup Status\ > \* Lowest-Level Menu Status
```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":{"AuthTargetBase":{"type":"object","description":"Authorization Target Basic Info","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call Method"},"useYn":{"type":"string","description":"Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}}},"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/menuMgmt/{rtTgtSeq}":{"put":{"tags":["Menu Information Management"],"summary":"Modify Menu Detail Information","description":"## Function Description\n* Modifies the detail information of a menu.\n---\n## Detailed Description\n* Required value list\n * Authorization Target Type Code\n * Authorization Target Name\n * Sort Order\n * Usage Status\n * System Modifier ID\n * Authorization Target Sequence No.\n * Customer Info Included Status\n * Popup Status\n * Lowest-Level Menu Status\n","operationId":"modifyMenu","parameters":[{"name":"rtTgtSeq","in":"path","description":"Authorization Target Sequence No.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthTargetBase"}}},"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 Menu List > \## Function Description\ > \* This is the API for retrieving the menu list.\ > \---\ > \## Detailed Description\ > \* Retrieves the saved menu list.\ > \---\ > \## Revision History\ > \* Release v2.00\_241017 : Retrieve menu tree list v2
```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":{"RealGridListResponseAuthTargetBase":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/AuthTargetBase"}}}},"AuthTargetBase":{"type":"object","description":"Authorization Target Basic Info","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call Method"},"useYn":{"type":"string","description":"Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/menuMgmt":{"get":{"tags":["Menu Information Management"],"summary":"Retrieve Menu List","description":"## Function Description\n* This is the API for retrieving the menu list.\n---\n## Detailed Description\n* Retrieves the saved menu list.\n---\n## Revision History\n* Release v2.00_241017 : Retrieve menu tree list v2\n","operationId":"getMenuList","parameters":[{"name":"sysGbCd","in":"query","description":"System Classification Code","schema":{"type":"string"}},{"name":"sysGbCdList","in":"query","description":"System Type Code List","schema":{"type":"array"}},{"name":"rtTgtTypCd","in":"query","description":"Permission Type Code","schema":{"type":"string"}},{"name":"rtTgtTypCdList","in":"query","description":"Permission Type Code List","schema":{"type":"array"}},{"name":"rtGrpNo","in":"query","description":"Authorization Group No.","schema":{"type":"string"}},{"name":"rtSubGbCd","in":"query","description":"Permission Subject Type Code","schema":{"type":"string"}},{"name":"rtTgtSeq","in":"query","description":"Authorization Target Sequence No.","schema":{"type":"string"}},{"name":"uprRtTgtSeq","in":"query","description":"Parent Authorization Target Sequence No.","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","schema":{"type":"number"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","schema":{"type":"number"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseAuthTargetBase"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Register Menu Detail Information > \## Function Description\ > \* Registers the detail information of a menu.\ > \---\ > \## Detailed Description\ > \* Required value list\ > \* Authorization Target Type Code\ > \* Authorization Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Modifier ID\ > \* System Type Code\ > \* Parent Authorization Target Sequence No.\ > \* System Registrant ID
```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":{"AuthTargetBase":{"type":"object","description":"Authorization Target Basic Info","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call Method"},"useYn":{"type":"string","description":"Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}}},"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/menuMgmt":{"post":{"tags":["Menu Information Management"],"summary":"Register Menu Detail Information","description":"## Function Description\n* Registers the detail information of a menu.\n---\n## Detailed Description\n* Required value list\n * Authorization Target Type Code\n * Authorization Target Name\n * Sort Order\n * Usage Status\n * System Modifier ID\n * System Type Code\n * Parent Authorization Target Sequence No.\n * System Registrant ID\n","operationId":"registerMenu","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthTargetBase"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Validate Menu Detail Information > \## Function Description\ > \* Validates the detailed information of a menu.\ > \---\ > \## Detailed Description\ > \* Required Value List\ > \* Permission Target Type Code\ > \* Permission Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Modifier ID\ > \* Permission Target Sequence No.\ > \* Customer Information Included Status\ > \* Popup Status\ > \* Lowest Level Menu Status
```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":{"AuthTargetBase":{"type":"object","description":"Authorization Target Basic Info","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call Method"},"useYn":{"type":"string","description":"Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}}},"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/menuMgmt/validation":{"post":{"tags":["Menu Information Management"],"summary":"Validate Menu Detail Information","description":"## Function Description\n* Validates the detailed information of a menu.\n---\n## Detailed Description\n* Required Value List\n * Permission Target Type Code\n * Permission Target Name\n * Sort Order\n * Usage Status\n * System Modifier ID\n * Permission Target Sequence No.\n * Customer Information Included Status\n * Popup Status\n * Lowest Level Menu Status\n","operationId":"validationMenu","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthTargetBase"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Set Individual Menu Permission > \## Function Description\ > \* Modifies the usage status of an individual permission.\ > \---\ > \## Detailed Description\ > \* Modifies the usage status of an individual permission.\ > \* Modifies to individual permission enabled, disabled, or group permission applied.
```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":{"StRtInfo":{"type":"object","description":"Permission Information Entity","properties":{"rtGrpNo":{"type":"string","description":"Authorization Group No."},"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtSubGbCd":{"type":"string","description":"Permission Subject Type Code (UR006)"},"useYn":{"type":"string","description":"Usage Status"},"groupYn":{"type":"string","description":"Group Permission Usage Status"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/menuMgmt/saveIndividualMenuRight":{"post":{"tags":["Menu Information Management"],"summary":"Set Individual Menu Permission","description":"## Function Description\n* Modifies the usage status of an individual permission.\n---\n## Detailed Description\n* Modifies the usage status of an individual permission.\n* Modifies to individual permission enabled, disabled, or group permission applied.\n","operationId":"saveIndividualMenuRight","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StRtInfo"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Save Submenu > \## Function Description\ > \* Registers, modifies, and deletes the submenu list of a menu.\ > \---\ > \## Detailed Description\ > \* Required Value List\ > \* Save\ > \* Permission Target Type Code\ > \* Permission Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Modifier ID\ > \* System Type Code\ > \* Parent Permission Target Sequence No.\ > \* System Registrant ID\ > \* Modify\ > \* Permission Target Type Code\ > \* Permission Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Modifier ID\ > \* Delete\ > \* Permission Target Type Code\ > \* Permission Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Modifier ID
```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":{"RealGridCUDRequestStRtTgtBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/StRtTgtBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/StRtTgtBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/StRtTgtBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/StRtTgtBase"}}}},"StRtTgtBase":{"type":"object","description":"Authorization Target Basic Info","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"rtTgtNm":{"type":"string","description":"Permission Target Name"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"useYn":{"type":"string","description":"Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"popupYn":{"type":"string","description":"Popup Status"},"btnId":{"type":"string","description":"Button ID"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/saveSubMenu":{"post":{"tags":["Menu Information Management"],"summary":"Save Submenu","description":"## Function Description\n* Registers, modifies, and deletes the submenu list of a menu.\n---\n## Detailed Description\n* Required Value List\n * Save\n * Permission Target Type Code\n * Permission Target Name\n * Sort Order\n * Usage Status\n * System Modifier ID\n * System Type Code\n * Parent Permission Target Sequence No.\n * System Registrant ID\n * Modify\n * Permission Target Type Code\n * Permission Target Name\n * Sort Order\n * Usage Status\n * System Modifier ID\n * Delete\n * Permission Target Type Code\n * Permission Target Name\n * Sort Order\n * Usage Status\n * System Modifier ID\n","operationId":"saveSubMenu","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestStRtTgtBase"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Modify Individual Permission Usage Status > \## Function Description\ > \* Modifies the usage status of an individual permission.\ > \---\ > \## Detailed Description\ > \* Modifies the usage status of an individual permission.\ > \* Modifies the list of checkedNodes to usage status Y.\ > \* Modifies the list of nonCheckedNodes to usage status N.
```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":{"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/saveMenuRightIndiv":{"post":{"tags":["Menu Information Management"],"summary":"Modify Individual Permission Usage Status","description":"## Function Description\n* Modifies the usage status of an individual permission.\n---\n## Detailed Description\n* Modifies the usage status of an individual permission.\n* Modifies the list of checkedNodes to usage status Y.\n* Modifies the list of nonCheckedNodes to usage status N.\n","operationId":"saveMenuRightIndiv","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Register Menu Detail Information > \## Function Description\ > \* Registers the detail information of a menu.\ > \---\ > \## Detailed Description\ > \* Required value list\ > \* Authorization Target Type Code\ > \* Authorization Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Modifier ID\ > \* System Type Code\ > \* Parent Authorization Target Sequence No.\ > \* System Registrant ID
```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":{"RtTargetBaseCudRequest":{"type":"object","properties":{"rtTgtSeq":{"type":"string"},"sysGbCd":{"type":"string","minLength":1},"rtTgtTypCd":{"type":"string","minLength":1},"rtTgtNm":{"type":"string","minLength":1},"sortSeq":{"type":"integer","format":"int32"},"callUrl":{"type":"string","minLength":1},"useYn":{"type":"string"},"custInfoInclYn":{"type":"string"},"rmkCont":{"type":"string"},"popupYn":{"type":"string"},"btnId":{"type":"string"},"uprRtTgtSeq":{"type":"string","minLength":1},"leafMenuYn":{"type":"string","minLength":1},"userHelpCont":{"type":"string"}},"required":["callUrl","leafMenuYn","rtTgtNm","rtTgtTypCd","sortSeq","sysGbCd","uprRtTgtSeq"]},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/registMenuInfo":{"post":{"tags":["Menu Information Management"],"summary":"Register Menu Detail Information","description":"## Function Description\n* Registers the detail information of a menu.\n---\n## Detailed Description\n* Required value list\n * Authorization Target Type Code\n * Authorization Target Name\n * Sort Order\n * Usage Status\n * System Modifier ID\n * System Type Code\n * Parent Authorization Target Sequence No.\n * System Registrant ID\n","operationId":"registMenuInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RtTargetBaseCudRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Modify Menu Permission Usage Status > \## Function Description\ > \* Modifies the usage status of a menu permission.\ > \---\ > \## Detailed Description\ > \* Modifies the usage status of a menu permission.\ > \* Modifies the list of checkedNodes to usage status Y.\ > \* Modifies the list of nonCheckedNodes to usage status N.
```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":{"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/modifyMenuRight":{"post":{"tags":["Menu Information Management"],"summary":"Modify Menu Permission Usage Status","description":"## Function Description\n* Modifies the usage status of a menu permission.\n---\n## Detailed Description\n* Modifies the usage status of a menu permission.\n* Modifies the list of checkedNodes to usage status Y.\n* Modifies the list of nonCheckedNodes to usage status N.\n","operationId":"modifyMenuRight","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Modify Menu Detail Information > \## Function Description\ > \* Modifies the detail information of a menu.\ > \---\ > \## Detailed Description\ > \* Required value list\ > \* Authorization Target Type Code\ > \* Authorization Target Name\ > \* Sort Order\ > \* Usage Status\ > \* System Modifier ID\ > \* Authorization Target Sequence No.\ > \* Customer Info Included Status\ > \* Popup Status\ > \* Lowest-Level Menu Status
```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":{"RtTargetBaseCudRequest":{"type":"object","properties":{"rtTgtSeq":{"type":"string"},"sysGbCd":{"type":"string","minLength":1},"rtTgtTypCd":{"type":"string","minLength":1},"rtTgtNm":{"type":"string","minLength":1},"sortSeq":{"type":"integer","format":"int32"},"callUrl":{"type":"string","minLength":1},"useYn":{"type":"string"},"custInfoInclYn":{"type":"string"},"rmkCont":{"type":"string"},"popupYn":{"type":"string"},"btnId":{"type":"string"},"uprRtTgtSeq":{"type":"string","minLength":1},"leafMenuYn":{"type":"string","minLength":1},"userHelpCont":{"type":"string"}},"required":["callUrl","leafMenuYn","rtTgtNm","rtTgtTypCd","sortSeq","sysGbCd","uprRtTgtSeq"]},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/modifyMenuInfo":{"post":{"tags":["Menu Information Management"],"summary":"Modify Menu Detail Information","description":"## Function Description\n* Modifies the detail information of a menu.\n---\n## Detailed Description\n* Required value list\n * Authorization Target Type Code\n * Authorization Target Name\n * Sort Order\n * Usage Status\n * System Modifier ID\n * Authorization Target Sequence No.\n * Customer Info Included Status\n * Popup Status\n * Lowest-Level Menu Status\n","operationId":"modifyMenuInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RtTargetBaseCudRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Mapped Parent Menu List > \## Function Description\ > \* Retrieves the mapped parent menu list inquiries.\ > \---\ > \## Detailed Description\ > \* Retrieves the mapped parent menu list inquiries.\ > \* Required Value List\ > \* Parent Permission Target Sequence No. List
```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":{"AuthTargetSearch":{"type":"object","description":"Permission Target Basic Search Model","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"uprRtTgtSeqList":{"type":"array","description":"Parent Authorization Target Sequence No. List","items":{"type":"string"}},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"sysGbCdList":{"type":"array","description":"System Type Code (UR005) List","items":{"type":"string"}},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"rtTgtTypCdList":{"type":"array","description":"Permission Target Type Code (UR010) List","items":{"type":"string"}},"rtGrpNo":{"type":"string","description":"Authorization Group No."},"rtSubGbCd":{"type":"string","description":"Authorization Subject Type Code (UR006)"},"useYn":{"type":"string","description":"Usage Status"}}},"ResponseListAuthTargetBase":{"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":"array","description":"payload","items":{"$ref":"#/components/schemas/AuthTargetBase"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"AuthTargetBase":{"type":"object","description":"Authorization Target Basic Info","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call Method"},"useYn":{"type":"string","description":"Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}}},"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/menuMgmt/upper":{"get":{"tags":["Menu Information Management"],"summary":"Retrieve Mapped Parent Menu List","description":"## Function Description\n* Retrieves the mapped parent menu list inquiries.\n---\n## Detailed Description\n* Retrieves the mapped parent menu list inquiries.\n* Required Value List\n * Parent Permission Target Sequence No. List\n","operationId":"getMappedUpperMenuList","parameters":[{"name":"authTargetSearch","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AuthTargetSearch"}},{"name":"uprRtTgtSeqList","in":"query","description":"Parent Authorization Target Sequence No. List","required":true,"schema":{"type":"array"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListAuthTargetBase"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Menu Tree List > \## Function Description\ > \* Retrieves the saved menus in a tree structure.\ > \---\ > \## Detailed Description\ > \* Retrieves the saved menus in a tree structure.\ > \---\ > \## Revision History\ > \* Release v2.00\_241017 : Retrieve menu tree list v2
```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":{"RtTargetBaseRequest":{"type":"object","properties":{"sysGbCd":{"type":"string"},"rtTgtSeq":{"type":"string"},"uprRtTgtSeq":{"type":"string"},"userId":{"type":"string"},"rtGrpNo":{"type":"string"},"rtSubGbCd":{"type":"string"},"indivRtNo":{"type":"string"},"useYn":{"type":"string"}}},"ResponseListRtTargetBaseResponse":{"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":"array","description":"payload","items":{"$ref":"#/components/schemas/RtTargetBaseResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RtTargetBaseResponse":{"type":"object","description":"Menu Permission Response DTO","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"level":{"type":"string","description":"Level"},"hierarchy":{"type":"string","description":"Tree Classification"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call URL"},"useYn":{"type":"string","description":"Usage Status"},"rtSubGbCd":{"type":"string","description":"Permission Subject Type Code (UR006)"},"groupYn":{"type":"string","description":"Group Authorization Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"}}},"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/menuMgmt/getMenuMgmtTreeList":{"get":{"tags":["Menu Information Management"],"summary":"Retrieve Menu Tree List","description":"## Function Description\n* Retrieves the saved menus in a tree structure.\n---\n## Detailed Description\n* Retrieves the saved menus in a tree structure.\n---\n## Revision History\n* Release v2.00_241017 : Retrieve menu tree list v2\n","operationId":"getMenuMgmtTreeList","parameters":[{"name":"rtTargetBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseRequest"}},{"name":"sysGbCd","in":"query","description":"System Classification Code","schema":{"type":"string"}},{"name":"rtGrpNo","in":"query","description":"Authorization Group No.","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListRtTargetBaseResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Sub Menu List > \## Function Description\ > \* Retrieves the sub menu list of the menu clicked on the screen.\ > \---\ > \## Detailed Description\ > \* Retrieves the sub menu list of the menu clicked on the screen.
```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":{"RtTargetBaseRequest":{"type":"object","properties":{"sysGbCd":{"type":"string"},"rtTgtSeq":{"type":"string"},"uprRtTgtSeq":{"type":"string"},"userId":{"type":"string"},"rtGrpNo":{"type":"string"},"rtSubGbCd":{"type":"string"},"indivRtNo":{"type":"string"},"useYn":{"type":"string"}}},"RtTargetBaseResponse":{"type":"object","description":"Menu Permission Response DTO","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"level":{"type":"string","description":"Level"},"hierarchy":{"type":"string","description":"Tree Classification"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call URL"},"useYn":{"type":"string","description":"Usage Status"},"rtSubGbCd":{"type":"string","description":"Permission Subject Type Code (UR006)"},"groupYn":{"type":"string","description":"Group Authorization Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/getSubMenuList":{"get":{"tags":["Menu Information Management"],"summary":"Retrieve Sub Menu List","description":"## Function Description\n* Retrieves the sub menu list of the menu clicked on the screen.\n---\n## Detailed Description\n* Retrieves the sub menu list of the menu clicked on the screen.\n","operationId":"getSubMenuList","parameters":[{"name":"rtTargetBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseRequest"}},{"name":"rtTgtSeq","in":"query","description":"Authorization Target Sequence No.","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":{"type":"array","items":{"$ref":"#/components/schemas/RtTargetBaseResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Sub Menu List Count > \## Function Description\ > \* Retrieves the sub menu list count of the menu clicked on the screen.\ > \---\ > \## Detailed Description\ > \* Retrieves the sub menu list count of the menu clicked on the screen.
```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":{"RtTargetBaseRequest":{"type":"object","properties":{"sysGbCd":{"type":"string"},"rtTgtSeq":{"type":"string"},"uprRtTgtSeq":{"type":"string"},"userId":{"type":"string"},"rtGrpNo":{"type":"string"},"rtSubGbCd":{"type":"string"},"indivRtNo":{"type":"string"},"useYn":{"type":"string"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/getSubMenuListCount":{"get":{"tags":["Menu Information Management"],"summary":"Retrieve Sub Menu List Count","description":"## Function Description\n* Retrieves the sub menu list count of the menu clicked on the screen.\n---\n## Detailed Description\n* Retrieves the sub menu list count of the menu clicked on the screen.\n","operationId":"getSubMenuListCount","parameters":[{"name":"rtTargetBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseRequest"}},{"name":"rtTgtSeq","in":"query","description":"Authorization Target Sequence No.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Check for Existence of Sub Menu > \## Function Description\ > \* Checks whether a sub menu exists for the permission target sequence number.\ > \---\ > \## Detailed Description\ > \* Checks whether a sub menu exists for the permission target sequence number.\ > \* Returns the count of menus whose parent permission target sequence number matches the given permission target sequence number.\ > \* Required value list\ > \* Permission Target Sequence No.
```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":{"RtTargetBaseRequest":{"type":"object","properties":{"sysGbCd":{"type":"string"},"rtTgtSeq":{"type":"string"},"uprRtTgtSeq":{"type":"string"},"userId":{"type":"string"},"rtGrpNo":{"type":"string"},"rtSubGbCd":{"type":"string"},"indivRtNo":{"type":"string"},"useYn":{"type":"string"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/getSubMenuCheck":{"get":{"tags":["Menu Information Management"],"summary":"Check for Existence of Sub Menu","description":"## Function Description\n* Checks whether a sub menu exists for the permission target sequence number.\n---\n## Detailed Description\n* Checks whether a sub menu exists for the permission target sequence number.\n* Returns the count of menus whose parent permission target sequence number matches the given permission target sequence number.\n* Required value list\n * Permission Target Sequence No.\n","operationId":"getSubMenuCheck","parameters":[{"name":"rtTargetBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseRequest"}},{"name":"rtTgtSeq","in":"query","description":"Authorization Target Sequence No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Check for Valid Permission Target > \## Function Description\ > \* Checks whether permission information exists for the permission target sequence number.\ > \---\ > \## Detailed Description\ > \* Checks whether permission information with a usage status of Y exists for the permission target sequence number.\ > \* Returns the count of menus with the given permission target sequence number.\ > \* Required value list\ > \* Permission Target Sequence No.
```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":{"RtTargetBaseRequest":{"type":"object","properties":{"sysGbCd":{"type":"string"},"rtTgtSeq":{"type":"string"},"uprRtTgtSeq":{"type":"string"},"userId":{"type":"string"},"rtGrpNo":{"type":"string"},"rtSubGbCd":{"type":"string"},"indivRtNo":{"type":"string"},"useYn":{"type":"string"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/getRtInfoCheck":{"get":{"tags":["Menu Information Management"],"summary":"Check for Valid Permission Target","description":"## Function Description\n* Checks whether permission information exists for the permission target sequence number.\n---\n## Detailed Description\n* Checks whether permission information with a usage status of Y exists for the permission target sequence number.\n* Returns the count of menus with the given permission target sequence number.\n* Required value list\n * Permission Target Sequence No.\n","operationId":"getRtInfoCheck","parameters":[{"name":"rtTargetBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseRequest"}},{"name":"rtTgtSeq","in":"query","description":"Authorization Target Sequence No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Menu Detail Information > \## Function Description\ > \* Retrieves the detail information of the menu clicked on the screen.\ > \---\ > \## Detailed Description\ > \* Retrieves the detail information of the menu clicked on the screen.
```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":{"RtTargetBaseRequest":{"type":"object","properties":{"sysGbCd":{"type":"string"},"rtTgtSeq":{"type":"string"},"uprRtTgtSeq":{"type":"string"},"userId":{"type":"string"},"rtGrpNo":{"type":"string"},"rtSubGbCd":{"type":"string"},"indivRtNo":{"type":"string"},"useYn":{"type":"string"}}},"RtTargetBaseResponse":{"type":"object","description":"Menu Permission Response DTO","properties":{"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Menu Name"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"popupYn":{"type":"string","description":"Popup Status"},"level":{"type":"string","description":"Level"},"hierarchy":{"type":"string","description":"Tree Classification"},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"rtTgtTypCd":{"type":"string","description":"Authorization Target Type Code (UR010)"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"callUrl":{"type":"string","description":"Call URL"},"httpMethod":{"type":"string","description":"Call URL"},"useYn":{"type":"string","description":"Usage Status"},"rtSubGbCd":{"type":"string","description":"Permission Subject Type Code (UR006)"},"groupYn":{"type":"string","description":"Group Authorization Usage Status"},"custInfoInclYn":{"type":"string","description":"Include Customer Information Status"},"rmkCont":{"type":"string","description":"Remarks"},"btnId":{"type":"string","description":"Button ID"},"leafMenuYn":{"type":"string","description":"Lowest-Level Menu Status"},"userHelpCont":{"type":"string","description":"User Help Content"}}},"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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/menuMgmt/getMenuInfo":{"get":{"tags":["Menu Information Management"],"summary":"Retrieve Menu Detail Information","description":"## Function Description\n* Retrieves the detail information of the menu clicked on the screen.\n---\n## Detailed Description\n* Retrieves the detail information of the menu clicked on the screen.\n","operationId":"getMenuInfo","parameters":[{"name":"rtTargetBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseRequest"}},{"name":"rtTgtSeq","in":"query","description":"Authorization Target Sequence No.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RtTargetBaseResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ```