> 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-12.md).
# 금칙어 관리
## 금칙어 다국어 목록 조회
> \## 기능설명\
> \* 금칙어의 다국어 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 기본 언어는 GNB에서 선택된 dataLangCd 기준으로 선택된 다국어 목록을 조회합니다.
```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":{"BadWordMgmtMlRequest":{"type":"object","description":"금칙어 다국어 조회/등록/수정 Request","properties":{"bwSeq":{"type":"string","description":"금칙어 순번"},"bwNm":{"type":"string","description":"금칙어 명"},"bwDesc":{"type":"string","description":"금칙어 설명"},"items":{"type":"array","description":"조회할 금칙어 번호 리스트","items":{"type":"string"}}},"required":["bwSeq"]},"RealGridListResponseBadWordMgmtMlResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlResponse"}}}},"BadWordMgmtMlResponse":{"type":"object","description":"금칙어 다국어 조회 Response","properties":{"langCd":{"type":"string","description":"언어코드"},"bwSeq":{"type":"string","description":"금칙어순번"},"bwNmKo":{"type":"string","description":"모국어 금칙어명"},"bwNm":{"type":"string","description":"다국어 금칙어명"},"bwDescKo":{"type":"string","description":"모국어 금칙어 설명"},"bwDesc":{"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":{"/v2/system/badWordMgmt/getBadWordMlList":{"post":{"tags":["금칙어 관리"],"summary":"금칙어 다국어 목록 조회","description":"## 기능설명\n* 금칙어의 다국어 목록을 조회합니다.\n---\n## 상세설명\n* 기본 언어는 GNB에서 선택된 dataLangCd 기준으로 선택된 다국어 목록을 조회합니다.\n","operationId":"getBadWordMlList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseBadWordMgmtMlResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 금칙어 저장/수정/삭제
> \## 기능설명\
> \* 화면에서 넘어온 금칙어 목록을 저장, 수정, 삭제합니다.\
> \---\
> \## 상세설명\
> \* 금칙어 등록 시 금칙어명(bwNm), 사용여부(useYn)는 필수입니다.\
> \* 금칙어 수정 시 금칙어순번(bwSeq), 금칙어명(bwNm), 사용여부(useYn)은 필수입니다.\
> \* 금칙어 삭제 시 금칙어순번(bwSeq)은 필수입니다.\
> \* 금칙어 등록, 수정 시 GNB 에 선택된 dataLangCd로 저장됩니다.
```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":{"RealGridCUDRequestBadWordMgmtRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtRequest"}}}},"BadWordMgmtRequest":{"type":"object","description":"금칙어 등록/수정/삭제 Request","properties":{"bwSeq":{"type":"string","description":"금칙어 순번"},"bwNm":{"type":"string","description":"금칙어 명"},"bwDesc":{"type":"string","description":"금칙어 설명"},"useYn":{"type":"string","description":"사용여부"}},"required":["bwNm","useYn"]},"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/badWordMgmt/saveBadWord":{"post":{"tags":["금칙어 관리"],"summary":"금칙어 저장/수정/삭제","description":"## 기능설명\n* 화면에서 넘어온 금칙어 목록을 저장, 수정, 삭제합니다.\n---\n## 상세설명\n* 금칙어 등록 시 금칙어명(bwNm), 사용여부(useYn)는 필수입니다.\n* 금칙어 수정 시 금칙어순번(bwSeq), 금칙어명(bwNm), 사용여부(useYn)은 필수입니다.\n* 금칙어 삭제 시 금칙어순번(bwSeq)은 필수입니다.\n* 금칙어 등록, 수정 시 GNB 에 선택된 dataLangCd로 저장됩니다.\n","operationId":"saveBadWord","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestBadWordMgmtRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"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":{"RealGridCUDRequestBadWordMgmtMlRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}}}},"BadWordMgmtMlRequest":{"type":"object","description":"금칙어 다국어 조회/등록/수정 Request","properties":{"bwSeq":{"type":"string","description":"금칙어 순번"},"bwNm":{"type":"string","description":"금칙어 명"},"bwDesc":{"type":"string","description":"금칙어 설명"},"items":{"type":"array","description":"조회할 금칙어 번호 리스트","items":{"type":"string"}}},"required":["bwSeq"]},"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/badWordMgmt/saveBadWordMl":{"post":{"tags":["금칙어 관리"],"summary":"금칙어 다국어 등록/수정","description":"## 기능설명\n* 금칙어 다국어를 등록 및 수정합니다.\n---\n## 상세설명\n* 넘어온 금칙어순번과 언어코드로 등록된 금칙어가 존재하면 다국어 금칙어를 수정합니다.\n* 넘어온 금칙어순번과 언어코드로 등록된 금칙어가 존재하지 않으면 신규로 다국어 금칙어를 등록합니다.\n","operationId":"saveBadWordMl","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestBadWordMgmtMlRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 금칙어 목록 조회
> \## 기능설명\
> \* 화면에서 넘어온 금칙어명, 사용여부 조건에 맞는 금칙어를 조회합니다.\
> \---\
> \## 상세설명\
> \* 화면에서 넘어온 금칙어명, 사용여부 조건에 맞는 금칙어와 금칙어에 대한 설명 목록을 조회합니다.\
> \* 조회언어는 GNB에서 선택된 dataLangCd의 쿠키 값을 사용합니다.
```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":{"BadWordMgmtRequest":{"type":"object","description":"금칙어 등록/수정/삭제 Request","properties":{"bwSeq":{"type":"string","description":"금칙어 순번"},"bwNm":{"type":"string","description":"금칙어 명"},"bwDesc":{"type":"string","description":"금칙어 설명"},"useYn":{"type":"string","description":"사용여부"}},"required":["bwNm","useYn"]},"RealGridListResponseBadWordMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtResponse"}}}},"BadWordMgmtResponse":{"type":"object","description":"금칙어 관리 조회 Response","properties":{"bwSeq":{"type":"string","description":"금칙어순번"},"bwNm":{"type":"string","description":"금칙어명"},"bwDesc":{"type":"string","description":"금칙어설명"},"useYn":{"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":{"/v2/system/badWordMgmt/getBadWordList":{"get":{"tags":["금칙어 관리"],"summary":"금칙어 목록 조회","description":"## 기능설명\n* 화면에서 넘어온 금칙어명, 사용여부 조건에 맞는 금칙어를 조회합니다.\n---\n## 상세설명\n* 화면에서 넘어온 금칙어명, 사용여부 조건에 맞는 금칙어와 금칙어에 대한 설명 목록을 조회합니다.\n* 조회언어는 GNB에서 선택된 dataLangCd의 쿠키 값을 사용합니다.\n","operationId":"getBadWordList","parameters":[{"name":"badWordMgmtRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},{"name":"bwNm","in":"query","description":"금칙어명","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"사용여부","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"현재 페이지","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"페이지 당 row","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseBadWordMgmtResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```