> 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/back-office-api/system-bo-api/undefined-25.md).
# 공통
## 권한대상 사용로그 등록
> \## 기능설명\
> \* 접속한 URL에 대한 권한대상 사용로그를 등록합니다.\
> \---\
> \## 상세설명\
> \* 접속한 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":["공통"],"summary":"권한대상 사용로그 등록","description":"## 기능설명\n* 접속한 URL에 대한 권한대상 사용로그를 등록합니다.\n---\n## 상세설명\n* 접속한 URL에 대한 사용자의 권한대상 사용로그를 등록합니다.\n","operationId":"insertStRtTgtBaseLog","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StRtTgtBaseLog"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## URL 권한 조회
> \## 기능설명\
> \* 화면 URL 에 대한 권한을 조회합니다.\
> \---\
> \## 상세설명\
> \* 화면 호출 URL 에 대한 사용자의 권한이 있는지를 조회합니다.\
> \* 조회할 수 있는 권한이 있을 시 0보다 큰 건 수를 반환합니다.\
> \* 아이디에 대한 시스템구분코드에 맞는 권한을 조회합니다.\
> \* 권한이 없을 시 (결과 = 0) 화면 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"},"username":{"type":"string"},"permissionToViewPersonalInfo":{"type":"object","additionalProperties":{}},"name":{"type":"string"},"enabled":{"type":"boolean"}},"required":["loginId"]},"PrivacyPolicyInfo":{"type":"object","description":"개인정보취급권한 DTO","properties":{"userId":{"type":"string","description":"사용자 아이디"},"indInfoGbCd":{"type":"string","description":"개인정보구분코드(UR008)"},"useYn":{"type":"string","description":"사용여부"}}},"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":["공통"],"summary":"URL 권한 조회","description":"## 기능설명\n* 화면 URL 에 대한 권한을 조회합니다.\n---\n## 상세설명\n* 화면 호출 URL 에 대한 사용자의 권한이 있는지를 조회합니다.\n* 조회할 수 있는 권한이 있을 시 0보다 큰 건 수를 반환합니다.\n* 아이디에 대한 시스템구분코드에 맞는 권한을 조회합니다.\n* 권한이 없을 시 (결과 = 0) 화면 URL에 대한 권한이 없는 것으로 판단합니다.\n","operationId":"getAdminGroups","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseLoginMenuInfoResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 웹에디터 이미지 파일 업로드
> \## 기능 설명\
> \- BO의 웹에디터(WYSIWYG)에서 이미지를 업로드할때 사용되는 API입니다.\
> \---\
> \## 상세 내용\
> \- 전달받은 이미지 데이터를 저장하고, 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":{"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":["공통"],"summary":"웹에디터 이미지 파일 업로드","description":"## 기능 설명\n- BO의 웹에디터(WYSIWYG)에서 이미지를 업로드할때 사용되는 API입니다.\n---\n## 상세 내용\n- 전달받은 이미지 데이터를 저장하고, url 경로를 돌려줍니다.\n","operationId":"uploadImgEditor","parameters":[{"name":"files","in":"query","description":"이미지 파일 목록","required":true,"schema":{"type":"string","format":"binary"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListUploadResDto"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 엑셀 다운로드 권한 체크
> \## 기능 설명\
> \- BO 사용자에게 엑셀 다운로드의 권한이 있는지 체크하는 API입니다.\
> \---\
> \## 상세 내용\
> \- 엑셀 다운로드 시 사용자에게 권한이 있는지 확인합니다.\
> \- 체크할 권한에 대한 세부 사항은 권한코드에 따라 다르게 설정합니다.\
> \- 01 : ID/이름/휴대폰번호 체크 (이벤트 상세 > 응모/추첨/지급관리 엑셀 다운로드 권한 & 이벤트 사은품 배송관리 엑셀 다운로드 권한)\
> \- 02 : ID/이름/고객계좌번호 체크 (수기 환불완료 관리 > 일괄 환불처리 엑셀 다운로드 권한)\
> \- 03 : 이름/전화번호/이메일 체크 (증빙서류 신청 관리 > 증빙서류 확인 권한)\
> \## 수정 번호\
> \* Release v2.01\_240923 : 권한코드 타입 추가(02:ID/이름/고객계좌번호 체크)\
> \* Release v2.01\_251020 : 권한코드 타입 추가(03:이름/전화번호/이메일 체크)
```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":"권한 체크 Request","properties":{"pmsCd":{"type":"string","description":"권한코드"}}},"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":["공통"],"summary":"엑셀 다운로드 권한 체크","description":"## 기능 설명\n- BO 사용자에게 엑셀 다운로드의 권한이 있는지 체크하는 API입니다.\n---\n## 상세 내용\n- 엑셀 다운로드 시 사용자에게 권한이 있는지 확인합니다.\n- 체크할 권한에 대한 세부 사항은 권한코드에 따라 다르게 설정합니다.\n- 01 : ID/이름/휴대폰번호 체크 (이벤트 상세 > 응모/추첨/지급관리 엑셀 다운로드 권한 & 이벤트 사은품 배송관리 엑셀 다운로드 권한)\n- 02 : ID/이름/고객계좌번호 체크 (수기 환불완료 관리 > 일괄 환불처리 엑셀 다운로드 권한)\n- 03 : 이름/전화번호/이메일 체크 (증빙서류 신청 관리 > 증빙서류 확인 권한)\n## 수정 번호\n * Release v2.01_240923 : 권한코드 타입 추가(02:ID/이름/고객계좌번호 체크)\n * Release v2.01_251020 : 권한코드 타입 추가(03:이름/전화번호/이메일 체크)\n","operationId":"hasListExcelDownloadPermission","parameters":[{"name":"permissionCodeRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PermissionCodeRequest"}},{"name":"pmsCd","in":"query","description":"권한코드","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 접속한 URL의 권한 정보 및 개인정보 유무 조회
> \## 기능설명\
> \* 접속 URL에 대한 사용자의 권한 정보와 개인정보 유무를 조회합니다.\
> \---\
> \## 상세설명\
> \* 접속 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":{"StRtTgtBase":{"type":"object","description":"권한대상기본","properties":{"rtTgtSeq":{"type":"string","description":"권한대상순번"},"sysGbCd":{"type":"string","description":"시스템구분코드(UR005)"},"rtTgtTypCd":{"type":"string","description":"권한대상유형코드(UR010)"},"rtTgtNm":{"type":"string","description":"권한대상명"},"sortSeq":{"type":"integer","format":"int32","description":"정렬순서"},"callUrl":{"type":"string","description":"호출URL"},"useYn":{"type":"string","description":"사용여부"},"custInfoInclYn":{"type":"string","description":"고객정보포함여부"},"rmkCont":{"type":"string","description":"비고내용"},"popupYn":{"type":"string","description":"팝업여부"},"btnId":{"type":"string","description":"버튼ID"},"uprRtTgtSeq":{"type":"string","description":"상위권한대상순번"},"leafMenuYn":{"type":"string","description":"최하위메뉴여부"},"userHelpCont":{"type":"string","description":"사용자도움말내용"}}},"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":["공통"],"summary":"접속한 URL의 권한 정보 및 개인정보 유무 조회","description":"## 기능설명\n* 접속 URL에 대한 사용자의 권한 정보와 개인정보 유무를 조회합니다.\n---\n## 상세설명\n* 접속 URL에 대한 사용자의 권한 정보와 개인정보 유무를 조회합니다.\n* 아이디에 대한 시스템구분코드에 맞는 권한을 조회합니다.\n","operationId":"getRtTgtSeqByStRtTgtBase","parameters":[{"name":"stRtTgtBase","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StRtTgtBase"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseStRtTgtBase"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 저장소 파일 다운로드
> \## 기능 설명\
> \- 저장소에 저장된 데이터를 직접 다운로드합니다.\
> \---\
> \## 상세 내용\
> \- 일반적으로 접근이 불가능한 경우에도 서버를 통해 다운로드가 가능한 기능을 지원합니다.
```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":["공통"],"summary":"저장소 파일 다운로드","description":"## 기능 설명\n- 저장소에 저장된 데이터를 직접 다운로드합니다.\n---\n## 상세 내용\n- 일반적으로 접근이 불가능한 경우에도 서버를 통해 다운로드가 가능한 기능을 지원합니다.\n","operationId":"downloadFile","parameters":[{"name":"fullPath","in":"query","description":"저장소 파일경로","required":true,"schema":{"type":"fullPath"}},{"name":"originalFileName","in":"query","description":"원본 파일명","required":true,"schema":{"type":"originalFileName"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```