> 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/usage-status-lookup-by-menu.md).

# Usage Status Lookup By Menu

## Retrieve Menu Usage Status List by User

> \## Function Description\
> \* Retrieves the menu usage status list by user matching the system type, user, usage period, and menu name.\
> \---\
> \## Detailed Description\
> \* Retrieves the menu usage status list by user matching the system type, user, usage period, and menu name.\
> \---\
> \## Revision History\
> \* Release v2.00\_240530: Changed date search query<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":{"RtTargetBaseLogRequest":{"type":"object","properties":{"userId":{"type":"string"},"sysGbCd":{"type":"string"},"userIdConditionParam":{"type":"string"},"userNmConditionParam":{"type":"string"},"useStrtDt":{"type":"string","format":"date"},"userEndDt":{"type":"string","format":"date"},"rtTgtNm":{"type":"string"}}},"RealGridListResponseRtTargetBaseLogResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/RtTargetBaseLogResponse"}}}},"RtTargetBaseLogResponse":{"type":"object","description":"Menu Usage Status Retrieval Response DTO","properties":{"sysGbNm":{"type":"string","description":"System Classification Name"},"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Permission Target Name"},"menuRegDt":{"type":"string","description":"Menu Registration Date"},"userCnt":{"type":"integer","format":"int64","description":"User Count"},"menuUseCnt":{"type":"integer","format":"int64","description":"Usage Count"},"lastUseDt":{"type":"string","description":"Last Used Date"},"userId":{"type":"string","description":"User ID"},"userNm":{"type":"string","description":"User Name"},"userMenuUseCnt":{"type":"integer","format":"int64","description":"Usage Count"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"}}},"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/menuUsageStatusInquiry/getUserMenuUseStatusList":{"get":{"tags":["Usage Status Lookup by Menu"],"summary":"Retrieve Menu Usage Status List by User","description":"## Function Description\n* Retrieves the menu usage status list by user matching the system type, user, usage period, and menu name.\n---\n## Detailed Description\n* Retrieves the menu usage status list by user matching the system type, user, usage period, and menu name.\n---\n## Revision History\n* Release v2.00_240530: Changed date search query\n","operationId":"getUserMenuUseStatusList","parameters":[{"name":"rtTargetBaseLogRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseLogRequest"}},{"name":"userId","in":"query","description":"User Name","schema":{"type":"String"}},{"name":"sysGbCd","in":"query","description":"System Classification Code","schema":{"type":"String"}},{"name":"useStrtDt","in":"query","description":"Search Start Date","schema":{"type":"LocalDate"}},{"name":"userEndDt","in":"query","description":"Search End Date","schema":{"type":"LocalDate"}},{"name":"rtTgtNm","in":"query","description":"Menu Name","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/RealGridListResponseRtTargetBaseLogResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Usage Status List by Menu

> \## Function Description\
> \* Retrieves the usage status list by menu matching the system type, user, usage period, and menu name.\
> \---\
> \## Detailed Description\
> \* Retrieves the usage status list by menu matching the system type, user, usage period, and menu name.\
> \* For a submenu, the parent menu can be viewed.<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":{"RtTargetBaseLogRequest":{"type":"object","properties":{"userId":{"type":"string"},"sysGbCd":{"type":"string"},"userIdConditionParam":{"type":"string"},"userNmConditionParam":{"type":"string"},"useStrtDt":{"type":"string","format":"date"},"userEndDt":{"type":"string","format":"date"},"rtTgtNm":{"type":"string"}}},"RealGridListResponseRtTargetBaseLogResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/RtTargetBaseLogResponse"}}}},"RtTargetBaseLogResponse":{"type":"object","description":"Menu Usage Status Retrieval Response DTO","properties":{"sysGbNm":{"type":"string","description":"System Classification Name"},"rtTgtSeq":{"type":"string","description":"Authorization Target Sequence No."},"rtTgtNm":{"type":"string","description":"Permission Target Name"},"menuRegDt":{"type":"string","description":"Menu Registration Date"},"userCnt":{"type":"integer","format":"int64","description":"User Count"},"menuUseCnt":{"type":"integer","format":"int64","description":"Usage Count"},"lastUseDt":{"type":"string","description":"Last Used Date"},"userId":{"type":"string","description":"User ID"},"userNm":{"type":"string","description":"User Name"},"userMenuUseCnt":{"type":"integer","format":"int64","description":"Usage Count"},"uprRtTgtSeq":{"type":"string","description":"Parent Authorization Target Sequence No."},"uprRtTgtNm":{"type":"string","description":"Parent Authority Target Name"}}},"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/menuUsageStatusInquiry/getMenuUseStatusList":{"get":{"tags":["Usage Status Lookup by Menu"],"summary":"Retrieve Usage Status List by Menu","description":"## Function Description\n* Retrieves the usage status list by menu matching the system type, user, usage period, and menu name.\n---\n## Detailed Description\n* Retrieves the usage status list by menu matching the system type, user, usage period, and menu name.\n* For a submenu, the parent menu can be viewed.\n","operationId":"getMenuUseStatusList","parameters":[{"name":"rtTargetBaseLogRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseLogRequest"}},{"name":"userId","in":"query","description":"User Name","schema":{"type":"String"}},{"name":"sysGbCd","in":"query","description":"System Classification Code","schema":{"type":"String"}},{"name":"useStrtDt","in":"query","description":"Search Start Date","schema":{"type":"String"}},{"name":"userEndDt","in":"query","description":"Search End Date","schema":{"type":"String"}},{"name":"rtTgtNm","in":"query","description":"Menu Name","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/RealGridListResponseRtTargetBaseLogResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Usage Count by Menu

> \## Function Description\
> \* Retrieves the usage count by menu matching the system type, user, usage period, and menu name.\
> \---\
> \## Detailed Description\
> \* Retrieves the usage count by menu matching the system type, user, usage period, and menu name.<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":{"RtTargetBaseLogRequest":{"type":"object","properties":{"userId":{"type":"string"},"sysGbCd":{"type":"string"},"userIdConditionParam":{"type":"string"},"userNmConditionParam":{"type":"string"},"useStrtDt":{"type":"string","format":"date"},"userEndDt":{"type":"string","format":"date"},"rtTgtNm":{"type":"string"}}},"ResponseInteger":{"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":"integer","format":"int32","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":{"/v1/system/menuUsageStatusInquiry/getMenuUseStatusListCount":{"get":{"tags":["Usage Status Lookup by Menu"],"summary":"Retrieve Usage Count by Menu","description":"## Function Description\n* Retrieves the usage count by menu matching the system type, user, usage period, and menu name.\n---\n## Detailed Description\n* Retrieves the usage count by menu matching the system type, user, usage period, and menu name.\n","operationId":"getMenuUseStatusListCount","parameters":[{"name":"rtTargetBaseLogRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RtTargetBaseLogRequest"}},{"name":"userId","in":"query","description":"User Name","schema":{"type":"String"}},{"name":"sysGbCd","in":"query","description":"System Classification Code","schema":{"type":"String"}},{"name":"useStrtDt","in":"query","description":"Search Start Date","schema":{"type":"String"}},{"name":"userEndDt","in":"query","description":"Search End Date","schema":{"type":"String"}},{"name":"rtTgtNm","in":"query","description":"Menu Name","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseInteger"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```