> 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/goods-bo-api/new-word-management.md).

# New Word Management

## Save/Modify/Delete New Word

> \## Function Description\
> \* Registers new word information for each site.\
> \---\
> \## Detailed Description\
> \* When registering a new word, site number (siteNo), new word name (nogmNm), and usage status (useYn) are required.\
> \* When modifying a new word, site number (siteNo), new word name (nogmNm), and usage status (useYn) can be modified.\
> \* Registered information is sent to the search engine via batch.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Search Service (added new word management)\ <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":{"RealGridCUDRequestNewWordMgmtRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/NewWordMgmtRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/NewWordMgmtRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/NewWordMgmtRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/NewWordMgmtRequest"}}}},"NewWordMgmtRequest":{"type":"object","properties":{"nogmSeq":{"type":"string"},"nogmNm":{"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/search/newWordMgmt/saveNewWord":{"post":{"tags":["New Word Management"],"summary":"Save/Modify/Delete New Word","description":"## Function Description\n* Registers new word information for each site.\n---\n## Detailed Description\n* When registering a new word, site number (siteNo), new word name (nogmNm), and usage status (useYn) are required.\n* When modifying a new word, site number (siteNo), new word name (nogmNm), and usage status (useYn) can be modified.\n* Registered information is sent to the search engine via batch.\n---\n## Revision History\n* ```Release v1.04_231120``` : Search Service (added new word management)\n\n","operationId":"saveNewWord","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestNewWordMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Search New Word List

> \## Function Description\
> \* A function that searches the new word list..\
> \
> \## Detailed Description\
> \* Search conditions: site code, new word name, usage status\
> \* The site number must be entered for the search to be performed.\
> \* The new word list managed for each site may differ or be the same.\
> \* The site list is displayed in descending order.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Search Service (added new word management)\ <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":{"NewWordMgmtRequest":{"type":"object","properties":{"nogmSeq":{"type":"string"},"nogmNm":{"type":"string"},"useYn":{"type":"string"}}},"NewWordMgmtResponse":{"type":"object","properties":{"nogmSeq":{"type":"string"},"nogmNm":{"type":"string"},"useYn":{"type":"string"},"totalCount":{"type":"integer","format":"int32"}}},"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/search/newWordMgmt/getNewWordList":{"get":{"tags":["New Word Management"],"summary":"Search New Word List","description":"## Function Description\n* A function that searches the new word list..\n\n## Detailed Description\n* Search conditions: site code, new word name, usage status\n* The site number must be entered for the search to be performed.\n* The new word list managed for each site may differ or be the same.\n* The site list is displayed in descending order.\n---\n## Revision History\n* ```Release v1.04_231120``` : Search Service (added new word management)\n\n","operationId":"getNewWordList","parameters":[{"name":"newWordMgmtRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/NewWordMgmtRequest"}},{"name":"siteNo","in":"query","description":"Site No.","required":true,"schema":{"type":"string"}},{"name":"siteNm","in":"query","description":"Site Name","schema":{"type":"string"}},{"name":"nogmNm","in":"query","description":"New Coined Word Name","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","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/NewWordMgmtResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Search New Word Count

> \## Function Description\
> \* A function that searches the number of new words..\
> \
> \---\
> \## Detailed Description\
> \*  Searches the number of new words by site.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Search Service (added new word management)<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":{"NewWordMgmtRequest":{"type":"object","properties":{"nogmSeq":{"type":"string"},"nogmNm":{"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/search/newWordMgmt/getNewWordListCount":{"get":{"tags":["New Word Management"],"summary":"Search New Word Count","description":"## Function Description\n* A function that searches the number of new words..\n\n---\n## Detailed Description\n*  Searches the number of new words by site.\n---\n## Revision History\n* ```Release v1.04_231120``` : Search Service (added new word management)\n","operationId":"getNewWordListCount","parameters":[{"name":"newWordMgmtRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/NewWordMgmtRequest"}},{"name":"siteNo","in":"query","description":"Site No.","required":true,"schema":{"type":"string"}},{"name":"siteNm","in":"query","description":"Site Name","schema":{"type":"string"}},{"name":"nogmNm","in":"query","description":"New Coined Word Name","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","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"}}}}}}}}}
````