> 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/common.md).
# Common
## Register Permission Target Usage Log
> \## Function Description\
> \* Registers a permission target usage log for the accessed URL.\
> \---\
> \## Detailed Description\
> \* Registers a user's permission target usage log for the accessed URL.
```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":{"StRtTgtBaseLog":{"type":"object","properties":{"userId":{"type":"string"},"rtTgtSeq":{"type":"string"},"workDtm":{"type":"string","format":"date-time"},"rtGrpNo":{"type":"string"},"callUrl":{"type":"string"},"prmtInfo":{"type":"string"},"ipAddr":{"type":"string"},"sysRegId":{"type":"string"},"sysRegDtm":{"type":"string","format":"date-time"}}},"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":{"/v1/common/common/insertStRtTgtBaseLog":{"post":{"tags":["Common"],"summary":"Register Permission Target Usage Log","description":"## Function Description\n* Registers a permission target usage log for the accessed URL.\n---\n## Detailed Description\n* Registers a user's permission target usage log for the accessed URL.\n","operationId":"insertStRtTgtBaseLog","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StRtTgtBaseLog"}}},"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 URL Permission
> \## Function Description\
> \* Retrieves the permission for a screen URL.\
> \---\
> \## Detailed Description\
> \* Retrieves whether the user has permission for the screen call URL.\
> \* Returns a count greater than 0 if there is a permission that can be retrieved.\
> \* Retrieves the permission matching the system type code for the ID.\
> \* If there is no permission (result = 0), it is determined that there is no permission for the screen URL.
```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":{"LoginRequest":{"type":"object","properties":{"seq":{"type":"integer","format":"int64"},"loginId":{"type":"string","minLength":1},"password":{"type":"string"},"remoteAddr":{"type":"string"},"lastAccessTime":{"type":"integer","format":"int64"},"userGbCd":{"type":"string"},"rtGrpNo":{"type":"string"},"jobGrpCd":{"type":"string"},"ocpCd":{"type":"string"},"caloUrl":{"type":"string"},"sysGbCd":{"type":"string"},"userId":{"type":"string"},"pwd":{"type":"string"},"userNm":{"type":"string"},"cellSctNo":{"type":"string"},"cellTxnoNo":{"type":"string"},"cellEndNo":{"type":"string"},"pwdIniYn":{"type":"string"},"sessId":{"type":"string"},"tpCd":{"type":"string"},"entrNo":{"type":"string"},"entrNm":{"type":"string"},"applicationName":{"type":"string"},"privacyPolicyInfoList":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyPolicyInfo"}},"accountNonExpired":{"type":"boolean"},"accountNonLocked":{"type":"boolean"},"credentialsNonExpired":{"type":"boolean"},"permissionToViewPersonalInfo":{"type":"object","additionalProperties":{}},"username":{"type":"string"},"name":{"type":"string"},"enabled":{"type":"boolean"}},"required":["loginId"]},"PrivacyPolicyInfo":{"type":"object","description":"Personal Information Handling Authorization DTO","properties":{"userId":{"type":"string","description":"User ID"},"indInfoGbCd":{"type":"string","description":"Personal Information Type Code (UR008)"},"useYn":{"type":"string","description":"Usage Status"}}},"ResponseLoginMenuInfoResponse":{"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/LoginMenuInfoResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"LoginMenuInfoResponse":{"type":"object","properties":{"rtTgtSeq":{"type":"string"},"rtTgtNm":{"type":"string"}}},"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/common/common/getAdminGroups":{"post":{"tags":["Common"],"summary":"Retrieve URL Permission","description":"## Function Description\n* Retrieves the permission for a screen URL.\n---\n## Detailed Description\n* Retrieves whether the user has permission for the screen call URL.\n* Returns a count greater than 0 if there is a permission that can be retrieved.\n* Retrieves the permission matching the system type code for the ID.\n* If there is no permission (result = 0), it is determined that there is no permission for the screen URL.\n","operationId":"getAdminGroups","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseLoginMenuInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Upload Web Editor Image File
> \## Function Description\
> \- This is the API used to upload an image in the BO's web editor (WYSIWYG).\
> \---\
> \## Detailed Description\
> \- Saves the received image data and returns the URL path.
```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":{"ResponseListUploadResDto":{"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/UploadResDto"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"UploadResDto":{"type":"object","properties":{"statusCode":{"type":"string"},"statusMsg":{"type":"string"},"orgFileName":{"type":"string"},"fileName":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"size":{"type":"integer","format":"int64"},"extension":{"type":"string"},"fullPath":{"type":"string"},"tempFullPath":{"type":"string"},"typeCd":{"type":"string"},"multipartFile":{"type":"string","format":"binary"}}},"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/common/common/file/uploadImgEditor":{"post":{"tags":["Common"],"summary":"Upload Web Editor Image File","description":"## Function Description\n- This is the API used to upload an image in the BO's web editor (WYSIWYG).\n---\n## Detailed Description\n- Saves the received image data and returns the URL path.\n","operationId":"uploadImgEditor","parameters":[{"name":"files","in":"query","description":"Image File List","required":true,"schema":{"type":"string","format":"binary"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListUploadResDto"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Check Excel Download Permission
> \## Function Description\
> \- API to check whether the BO user has permission to download Excel.\
> \---\
> \## Detailed Description\
> \- Checks whether the user has permission when downloading Excel.\
> \- The details of the permission to check are set differently depending on the permission code.\
> \- 01 : ID/Name/Mobile Number check (Event Detail > Entry/Drawing/Payment Management Excel Download Permission & Event Gift Delivery Management Excel Download Permission)\
> \- 02 : ID/Name/Customer Account Number check (Manual Refund Completion Management > Batch Refund Processing Excel Download Permission)\
> \- 03 : Name/Phone Number/Email check (Supporting Document Application Management > Supporting Document Verification Permission)\
> \## Revision History\
> \* Release v2.01\_240923 : Added permission code type (02: ID/Name/Customer Account Number check)\
> \* Release v2.01\_251020 : Added permission code type (03: Name/Phone Number/Email check)
```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":{"PermissionCodeRequest":{"type":"object","description":"Permission Check Request","properties":{"pmsCd":{"type":"string","description":"Authorization Code"}}},"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/common/common/hasListExcelDownloadPermission":{"get":{"tags":["Common"],"summary":"Check Excel Download Permission","description":"## Function Description\n- API to check whether the BO user has permission to download Excel.\n---\n## Detailed Description\n- Checks whether the user has permission when downloading Excel.\n- The details of the permission to check are set differently depending on the permission code.\n- 01 : ID/Name/Mobile Number check (Event Detail > Entry/Drawing/Payment Management Excel Download Permission & Event Gift Delivery Management Excel Download Permission)\n- 02 : ID/Name/Customer Account Number check (Manual Refund Completion Management > Batch Refund Processing Excel Download Permission)\n- 03 : Name/Phone Number/Email check (Supporting Document Application Management > Supporting Document Verification Permission)\n## Revision History\n * Release v2.01_240923 : Added permission code type (02: ID/Name/Customer Account Number check)\n * Release v2.01_251020 : Added permission code type (03: Name/Phone Number/Email check)\n","operationId":"hasListExcelDownloadPermission","parameters":[{"name":"permissionCodeRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PermissionCodeRequest"}},{"name":"pmsCd","in":"query","description":"Authorization Code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Permission Information and Personal Data Presence for Accessed URL
> \## Function Description\
> \* Retrieves the user's permission information and personal data presence for the accessed URL.\
> \---\
> \## Detailed Description\
> \* Retrieves the user's permission information and personal data presence for the accessed URL.\
> \* Retrieves the permission matching the system type code for the 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":{"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"}}},"ResponseStRtTgtBase":{"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/StRtTgtBase","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/common/common/getRtTgtSeqByStRtTgtBase":{"get":{"tags":["Common"],"summary":"Retrieve Permission Information and Personal Data Presence for Accessed URL","description":"## Function Description\n* Retrieves the user's permission information and personal data presence for the accessed URL.\n---\n## Detailed Description\n* Retrieves the user's permission information and personal data presence for the accessed URL.\n* Retrieves the permission matching the system type code for the ID.\n","operationId":"getRtTgtSeqByStRtTgtBase","parameters":[{"name":"stRtTgtBase","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StRtTgtBase"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseStRtTgtBase"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Download Storage File
> \## Function Description\
> \- Directly downloads data stored in the storage.\
> \---\
> \## Detailed Description\
> \- Supports a function that allows downloading via the server even in cases where access is normally not possible.
```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/common/common/downloadFile":{"get":{"tags":["Common"],"summary":"Download Storage File","description":"## Function Description\n- Directly downloads data stored in the storage.\n---\n## Detailed Description\n- Supports a function that allows downloading via the server even in cases where access is normally not possible.\n","operationId":"downloadFile","parameters":[{"name":"fullPath","in":"query","description":"Storage File Path","required":true,"schema":{"type":"fullPath"}},{"name":"originalFileName","in":"query","description":"Original File Name","required":true,"schema":{"type":"originalFileName"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```