> 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/synonym-management.md).

# Synonym Management

## Save/Edit/Delete Synonym

> \## Function Description\
> \* Registers synonym information.\
> \
> \---\
> \## Detailed Description\
> \* When registering a synonym, base word (synWrd), synonym name (synNm), and usage status (useYn) are required.\
> \* When modifying a synonym, base word (synWrd), synonym name (synNm), 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 synonym 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":{"RealGridCUDRequestSameWordMgmtRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/SameWordMgmtRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/SameWordMgmtRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/SameWordMgmtRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/SameWordMgmtRequest"}}}},"SameWordMgmtRequest":{"type":"object","properties":{"synSeq":{"type":"string"},"stdWrd":{"type":"string"},"synNm":{"type":"string"},"useYn":{"type":"string"},"relTypCd":{"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/sameWordMgmt/saveSameWord":{"post":{"tags":["Synonym Management"],"summary":"Save/Edit/Delete Synonym","description":"## Function Description\n* Registers synonym information.\n\n---\n## Detailed Description\n* When registering a synonym, base word (synWrd), synonym name (synNm), and usage status (useYn) are required.\n* When modifying a synonym, base word (synWrd), synonym name (synNm), 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 synonym management)\n","operationId":"saveSameWord","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestSameWordMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Search Synonym List

> \## Function Description\
> \* A function that searches the synonym status.\
> \---\
> \## Detailed Description\
> \* Search conditions: base word, usage status\
> \* If no search conditions are entered, the entire synonym status is searched.\
> \* The synonym list is displayed in descending order.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Search Service (added synonym 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":{"SameWordMgmtRequest":{"type":"object","properties":{"synSeq":{"type":"string"},"stdWrd":{"type":"string"},"synNm":{"type":"string"},"useYn":{"type":"string"},"relTypCd":{"type":"string"}}},"SameWordMgmtResponse":{"type":"object","properties":{"synSeq":{"type":"string"},"stdWrd":{"type":"string"},"synNm":{"type":"string"},"useYn":{"type":"string"},"relTypCd":{"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/sameWordMgmt/getSameWordList":{"get":{"tags":["Synonym Management"],"summary":"Search Synonym List","description":"## Function Description\n* A function that searches the synonym status.\n---\n## Detailed Description\n* Search conditions: base word, usage status\n* If no search conditions are entered, the entire synonym status is searched.\n* The synonym list is displayed in descending order.\n---\n## Revision History\n* ```Release v1.04_231120``` : Search Service (added synonym management)\n","operationId":"getSameWordList","parameters":[{"name":"sameWordMgmtRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SameWordMgmtRequest"}},{"name":"stdWrd","in":"query","description":"Reference Word","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/SameWordMgmtResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Search Synonym Count

> \## Function Description\
> \* A function that searches the number of synonyms.\
> \---\
> \## Detailed Description\
> \*  Searches the number of synonyms.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Search Service (added synonym 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":{"SameWordMgmtRequest":{"type":"object","properties":{"synSeq":{"type":"string"},"stdWrd":{"type":"string"},"synNm":{"type":"string"},"useYn":{"type":"string"},"relTypCd":{"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/sameWordMgmt/getSameWordListCount":{"get":{"tags":["Synonym Management"],"summary":"Search Synonym Count","description":"## Function Description\n* A function that searches the number of synonyms.\n---\n## Detailed Description\n*  Searches the number of synonyms.\n---\n## Revision History\n* ```Release v1.04_231120``` : Search Service (added synonym management)\n","operationId":"getSameWordListCount","parameters":[{"name":"sameWordMgmtRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SameWordMgmtRequest"}},{"name":"stdWrd","in":"query","description":"Reference Word","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"}}}}}}}}}
````