> 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/retrieve-common-code.md).
# Retrieve Common Code
## Retrieve Common Code by Type
> \## Function Description\
> \* Retrieves common codes by search type.\
> \---\
> \## Detailed Description\
> \* Retrieves common codes based on the given search type (type).\
> \* Search Method by Search Type\
> \* T (table lookup), code, 'SITE', referCode : CC\_SITE\_BASE : Retrieve site number, site name\
> \* NC (normal type lookup) : Sequential lookup of general common codes\
> \* NMC (normal multi lookup) : Sequential lookup of general common codes\
> \* RC (reference value based lookup) : Common code lookup based on reference value 1\
> \* Returns a Map in the form of a group code and common code list.\
> \* The search language is based on the langCd cookie value of the default set language code.\
> \---\
> \### Code Reference\
> \* \`\`\`Search Type\`\`\` : T (table lookup), NC (normal type lookup), NMC (normal multi lookup), RC (reference value based lookup)
````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":{"CodeReqDto":{"type":"object","description":"Common Code Retrieval Request DTO","properties":{"code":{"type":"string","description":"Group Code"},"referCode":{"type":"string","description":"Reference Code"},"type":{"type":"string","description":"Search Type"},"grpCds":{"type":"string","description":"Group Code"},"langCd":{"type":"string","description":"Language Code"}}},"ResponseMapStringListCodeResDto":{"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":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/CodeResDto"}},"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"CodeResDto":{"type":"object","description":"Common Code Retrieval Response DTO","properties":{"key":{"type":"string","description":"Map Key"},"cd":{"type":"string","description":"Group Code"},"cdNm":{"type":"string","description":"Code Name"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"}}},"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/code/getForwardCdCdNmByMixedCode":{"post":{"tags":["Retrieve Common Code"],"summary":"Retrieve Common Code by Type","description":"## Function Description\n* Retrieves common codes by search type.\n---\n## Detailed Description\n* Retrieves common codes based on the given search type (type).\n* Search Method by Search Type\n * T (table lookup), code, 'SITE', referCode : CC_SITE_BASE : Retrieve site number, site name\n * NC (normal type lookup) : Sequential lookup of general common codes\n * NMC (normal multi lookup) : Sequential lookup of general common codes\n * RC (reference value based lookup) : Common code lookup based on reference value 1\n* Returns a Map in the form of a group code and common code list.\n* The search language is based on the langCd cookie value of the default set language code.\n---\n### Code Reference\n* ```Search Type``` : T (table lookup), NC (normal type lookup), NMC (normal multi lookup), RC (reference value based lookup)\n","operationId":"getForwardCdCdNmByMixedCode","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CodeReqDto"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseMapStringListCodeResDto"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Retrieve Buttons with Permission
> \## Function Description\
> \* Retrieves the button IDs that have permission for the screen.\
> \---\
> \## Detailed Description\
> \* Returns the button IDs that are accessible based on the permission information matching the call URL and system type code.\
> \* Returned in the form 'buttonID,buttonID'.\
> \* Retrieves individual permission with priority over group permission. (e.g., if individual permission is 'N' and group permission is 'Y', 'N' is returned as the access permission)\
> \---\
> \## Revision History\
> \* Release v1.00\_250320: Changed the button list with permission to a whitelist
```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"}}},"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/code/getEnabledButtonByPageRoleList":{"post":{"tags":["Retrieve Common Code"],"summary":"Retrieve Buttons with Permission","description":"## Function Description\n* Retrieves the button IDs that have permission for the screen.\n---\n## Detailed Description\n* Returns the button IDs that are accessible based on the permission information matching the call URL and system type code.\n* Returned in the form 'buttonID,buttonID'.\n* Retrieves individual permission with priority over group permission. (e.g., if individual permission is 'N' and group permission is 'Y', 'N' is returned as the access permission)\n---\n## Revision History\n* Release v1.00_250320: Changed the button list with permission to a whitelist\n","operationId":"getEnabledButtonByPageRoleList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"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 Buttons Without Save Permission
> \## Function Description\
> \* Retrieves the button IDs that do not have save permission for the screen.\
> \---\
> \## Detailed Description\
> \* Returns the button IDs that are inaccessible based on the data save permission information matching the call URL and system type code.\
> \* Returned in the form '#buttonID,#buttonID'.
```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"}}},"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/code/getButtonByUserList":{"post":{"tags":["Retrieve Common Code"],"summary":"Retrieve Buttons Without Save Permission","description":"## Function Description\n* Retrieves the button IDs that do not have save permission for the screen.\n---\n## Detailed Description\n* Returns the button IDs that are inaccessible based on the data save permission information matching the call URL and system type code.\n* Returned in the form '#buttonID,#buttonID'.\n","operationId":"getButtonByUserList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"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 Buttons Without Permission
> \## Function Description\
> \* Retrieves the button IDs that do not have permission for the screen.\
> \---\
> \## Detailed Description\
> \* Returns the button IDs that are inaccessible based on the permission information matching the call URL and system type code.\
> \* Returned in the form '#buttonID,#buttonID'.\
> \---\
> \## Revision History\
> \* Release v2.00\_240711: Changed to retrieve only button IDs that have neither group permission nor individual permission\
> \* Release v2.01\_250314: Changed to retrieve individual permission with priority over group permission
```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"}}},"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/code/getButtonByPageRoleList":{"post":{"tags":["Retrieve Common Code"],"summary":"Retrieve Buttons Without Permission","description":"## Function Description\n* Retrieves the button IDs that do not have permission for the screen.\n---\n## Detailed Description\n* Returns the button IDs that are inaccessible based on the permission information matching the call URL and system type code.\n* Returned in the form '#buttonID,#buttonID'.\n---\n## Revision History\n* Release v2.00_240711: Changed to retrieve only button IDs that have neither group permission nor individual permission\n* Release v2.01_250314: Changed to retrieve individual permission with priority over group permission\n","operationId":"getButtonByPageRoleList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"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 Common Code
> \## Function Description\
> \* Retrieves the common code.\
> \---\
> \## Detailed Description\
> \* Splits the passed parameter by ',' and retrieves the common code list for the corresponding group code.\
> \* Retrieves the common code list where the usage status is \*\*Y\*\*.\
> \* Retrieves sequentially based on the code's sort order.\
> \* Returns a Map in the form of a group code and common code list.\
> \* The retrieval language is based on the langCd cookie value, the default set language code.
```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":{"ResponseMapStringListStStdCd":{"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":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 Description"}}},"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/code/getStStdCd":{"get":{"tags":["Retrieve Common Code"],"summary":"Retrieve Common Code","description":"## Function Description\n* Retrieves the common code.\n---\n## Detailed Description\n* Splits the passed parameter by ',' and retrieves the common code list for the corresponding group code.\n* Retrieves the common code list where the usage status is **Y**.\n* Retrieves sequentially based on the code's sort order.\n* Returns a Map in the form of a group code and common code list.\n* The retrieval language is based on the langCd cookie value, the default set language code.\n","operationId":"getStStdCd","parameters":[{"name":"grpCds","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseMapStringListStStdCd"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Common Code by GNB Language
> \## Function Description\
> \* Retrieves the common code.\
> \---\
> \## Detailed Description\
> \* Splits the passed parameter by ',' and retrieves the common code list for the corresponding group code.\
> \* Retrieves the common code list where the usage status is \*\*Y\*\*.\
> \* Retrieves sequentially based on the code's sort order.\
> \* Returns a Map in the form of a group code and common code list.\
> \* The retrieval language is based on the dataLangCd cookie value, the default set language code.
```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":{"ResponseMapStringListStStdCd":{"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":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 Description"}}},"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/code/getStStdCdByDataLangCd":{"get":{"tags":["Retrieve Common Code"],"summary":"Retrieve Common Code by GNB Language","description":"## Function Description\n* Retrieves the common code.\n---\n## Detailed Description\n* Splits the passed parameter by ',' and retrieves the common code list for the corresponding group code.\n* Retrieves the common code list where the usage status is **Y**.\n* Retrieves sequentially based on the code's sort order.\n* Returns a Map in the form of a group code and common code list.\n* The retrieval language is based on the dataLangCd cookie value, the default set language code.\n","operationId":"getStStdCdByDataLangCd","parameters":[{"name":"grpCds","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseMapStringListStStdCd"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Common Code in Reverse Order
> \## Function Description\
> \* Retrieves the common code in reverse order.\
> \---\
> \## Detailed Description\
> \* Splits the passed parameter by ',' and retrieves the common code list for the corresponding group code.\
> \* Retrieves the common code list where the usage status is \*\*Y\*\*.\
> \* Retrieves in reverse order based on the code's sort order.\
> \* Returns a Map in the form of a group code and common code list.\
> \* The retrieval language is based on the langCd cookie value, the default set language code.
```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":{"ResponseMapStringListStStdCd":{"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":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 Description"}}},"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/code/getReverseStStdCd":{"get":{"tags":["Retrieve Common Code"],"summary":"Retrieve Common Code in Reverse Order","description":"## Function Description\n* Retrieves the common code in reverse order.\n---\n## Detailed Description\n* Splits the passed parameter by ',' and retrieves the common code list for the corresponding group code.\n* Retrieves the common code list where the usage status is **Y**.\n* Retrieves in reverse order based on the code's sort order.\n* Returns a Map in the form of a group code and common code list.\n* The retrieval language is based on the langCd cookie value, the default set language code.\n","operationId":"getReverseStStdCd","parameters":[{"name":"grpCds","in":"query","description":"Group Code String","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseMapStringListStStdCd"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Common Code by Reference 1 Value
> \## Function Description\
> \* Retrieves the common code list based on the reference 1 value.\
> \---\
> \## Detailed Description\
> \* Retrieves the common code list based on the reference 1 value held by the code.\
> \* Retrieves the common code list where the usage status is \*\*Y\*\*.\
> \* Reference Code (referCode) and Code (code) are required.
```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":{"CodeReqDto":{"type":"object","description":"Common Code Retrieval Request DTO","properties":{"code":{"type":"string","description":"Group Code"},"referCode":{"type":"string","description":"Reference Code"},"type":{"type":"string","description":"Search Type"},"grpCds":{"type":"string","description":"Group Code"},"langCd":{"type":"string","description":"Language Code"}}},"ResponseMapStringListCodeResDto":{"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":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/CodeResDto"}},"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"CodeResDto":{"type":"object","description":"Common Code Retrieval Response DTO","properties":{"key":{"type":"string","description":"Map Key"},"cd":{"type":"string","description":"Group Code"},"cdNm":{"type":"string","description":"Code Name"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"}}},"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/code/getForwardCdCdNmFromStStdCdByGrpCdRef1Val":{"get":{"tags":["Retrieve Common Code"],"summary":"Retrieve Common Code by Reference 1 Value","description":"## Function Description\n* Retrieves the common code list based on the reference 1 value.\n---\n## Detailed Description\n* Retrieves the common code list based on the reference 1 value held by the code.\n* Retrieves the common code list where the usage status is **Y**.\n* Reference Code (referCode) and Code (code) are required.\n","operationId":"getForwardCdCdNmFromStStdCdByGrpCdRef1Val","parameters":[{"name":"params","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CodeReqDto"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseMapStringListCodeResDto"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Common Code by Reference 3 Value
> \## Function Description\
> \* Retrieves the common code list based on the reference 3 value.\
> \---\
> \## Detailed Description\
> \* Retrieves the common code list based on the reference 3 value held by the code.\
> \* Retrieves the common code list where the usage status is \*\*Y\*\*.\
> \* Reference Code (referCode) and Code (code) are required.
```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":{"CodeReqDto":{"type":"object","description":"Common Code Retrieval Request DTO","properties":{"code":{"type":"string","description":"Group Code"},"referCode":{"type":"string","description":"Reference Code"},"type":{"type":"string","description":"Search Type"},"grpCds":{"type":"string","description":"Group Code"},"langCd":{"type":"string","description":"Language Code"}}},"ResponseMapStringListCodeResDto":{"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":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/CodeResDto"}},"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"CodeResDto":{"type":"object","description":"Common Code Retrieval Response DTO","properties":{"key":{"type":"string","description":"Map Key"},"cd":{"type":"string","description":"Group Code"},"cdNm":{"type":"string","description":"Code Name"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"}}},"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/code/getCdCdNmFromStStdCdByGrpCdOrderRef3Val":{"get":{"tags":["Retrieve Common Code"],"summary":"Retrieve Common Code by Reference 3 Value","description":"## Function Description\n* Retrieves the common code list based on the reference 3 value.\n---\n## Detailed Description\n* Retrieves the common code list based on the reference 3 value held by the code.\n* Retrieves the common code list where the usage status is **Y**.\n* Reference Code (referCode) and Code (code) are required.\n","operationId":"getCdCdNmFromStStdCdByGrpCdOrderRef3Val","parameters":[{"name":"params","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CodeReqDto"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseMapStringListCodeResDto"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```