PATCH/business-support/approval/linkage-codes/{linkageCodeKey}

연동 코드를 부분 수정한다.

Authorization

oauth2

Scope

businessSupport.approval

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/business-support/approval/linkage-codes/{linkageCodeKey}

Path Parameters

ParameterTypeDescription
linkageCodeKey string 

연동 코드 Key


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

연동 코드 수정 요청 데이터

PropertyTypeDescription
linkageCodeName string 

연동 코드 이름


required
minLength : 1
maxLength : 100 
i18nNames array (i18nName) 

다국어 목록 정보.
Admin > 기본환경 > 회사 정보 > 다국어 설정에서 지정된 항목의 다국어만 표시된다.

 
enabled boolean 

연동 코드 사용 여부


default : false 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
minLength : 1
maxLength : 100 
language string 

다국어 언어 코드


required
Allowed values : ko_KR, en_US, ja_JP, zh_CN, zh_TW 

Request Example

Example 1

1{2  "linkageCodeName": "채소",3  "i18nNames": [4    {5      "language": "en_US",6      "name": "vegetables"7    },8    {9      "language": "ko_KR",10      "name": "채소"11    },12    {13      "language": "ja_JP",14      "name": "野菜"15    }16  ],17  "enabled": true18}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

도메인 ID


format : int32 
linkageCodeKey string 

연동 코드 Key

 
linkageCodeName string 

연동 코드 이름

 
i18nNames array (i18nName) 

다국어 목록 정보.
Admin > 기본환경 > 회사 정보 > 다국어 설정에서 지정된 항목의 다국어만 표시된다.

 
enabled boolean 

연동 코드 사용 여부

 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
minLength : 1
maxLength : 100 
language string 

다국어 언어 코드


required
Allowed values : ko_KR, en_US, ja_JP, zh_CN, zh_TW 

HTTP 404

연동 코드 오류

PropertyTypeDescription
code string 

오류 코드

 
description string 

코드 설명

 

Response Example

An internal server(500)

1{2  "code": "INTERNAL_SERVER_ERROR",3  "description": "An internal server error occurred."4}

DomainId does not exist.(404)

1{2  "code": "DOMAIN_ID_NOT_FOUND",3  "description": "domainId does not exist."4}

Linkage code does not exist.(404)

1{2  "code": "LINKAGE_CODE_NOT_FOUND",3  "description": "Linkage code does not exist."4}

Linkage code item cannot be deleted.(500)

1{2  "code": "INTERNAL_SERVER_ERROR",3  "description": "Linkage code item cannot be deleted."4}

Count must be between 1 and 200.(400)

1{2  "code": "OUT_OF_RANGE",3  "description": "count must be between 1 and 200."4}

Linkage code already exists.(409)

1{2  "code": "LINKAGE_CODE_ID_ALREADY_EXIST",3  "description": "Linkage code already exists."4}

Linkage code item already exists.(409)

1{2  "code": "LINKAGE_CODE_ITEM_ID_ALREADY_EXIST",3  "description": "linkageCodeItem already exists."4}

Linkage code item does not exist.(404)

1{2  "code": "LINKAGE_CODE_ITEM_NOT_FOUND",3  "description": "linkageCodeItem does not exist."4}

Access is denied.(403)

1{2  "code": "ACCESS_DENIED",3  "description": "Access is denied"4}

LINKAGE_CODE_KEY_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeKey is invalid."4}

LINKAGE_CODE_KEY_INVALID_SIZE(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkageCodeKey size (30) was exceeded."4}

LINKAGE_CODE_ITEM_KEY_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeItemId is invalid."4}

LINKAGE_CODE_ITEM_KEY_INVALID_SIZE(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkageCodeItemId (100) was exceeded."4}

LINKAGE_CODE_NAME_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeName is invalid."4}

LINKAGE_CODE_ITEM_NAME_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeItemName is invalid."4}

CURSOR_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Cursor is invalid."4}

LINKAGE_CODE_ITEM_INVALID_ENABLED(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Linkage code item's enabled can be up to 1 true."4}

LINKAGE_CODE_ITEM_LIMIT_EXCEEDED(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkage code item count(10,000) was exceeded.."4}

HTTP 409

연동 코드 오류

PropertyTypeDescription
code string 

오류 코드

 
description string 

코드 설명

 

Response Example

An internal server(500)

1{2  "code": "INTERNAL_SERVER_ERROR",3  "description": "An internal server error occurred."4}

DomainId does not exist.(404)

1{2  "code": "DOMAIN_ID_NOT_FOUND",3  "description": "domainId does not exist."4}

Linkage code does not exist.(404)

1{2  "code": "LINKAGE_CODE_NOT_FOUND",3  "description": "Linkage code does not exist."4}

Linkage code item cannot be deleted.(500)

1{2  "code": "INTERNAL_SERVER_ERROR",3  "description": "Linkage code item cannot be deleted."4}

Count must be between 1 and 200.(400)

1{2  "code": "OUT_OF_RANGE",3  "description": "count must be between 1 and 200."4}

Linkage code already exists.(409)

1{2  "code": "LINKAGE_CODE_ID_ALREADY_EXIST",3  "description": "Linkage code already exists."4}

Linkage code item already exists.(409)

1{2  "code": "LINKAGE_CODE_ITEM_ID_ALREADY_EXIST",3  "description": "linkageCodeItem already exists."4}

Linkage code item does not exist.(404)

1{2  "code": "LINKAGE_CODE_ITEM_NOT_FOUND",3  "description": "linkageCodeItem does not exist."4}

Access is denied.(403)

1{2  "code": "ACCESS_DENIED",3  "description": "Access is denied"4}

LINKAGE_CODE_KEY_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeKey is invalid."4}

LINKAGE_CODE_KEY_INVALID_SIZE(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkageCodeKey size (30) was exceeded."4}

LINKAGE_CODE_ITEM_KEY_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeItemId is invalid."4}

LINKAGE_CODE_ITEM_KEY_INVALID_SIZE(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkageCodeItemId (100) was exceeded."4}

LINKAGE_CODE_NAME_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeName is invalid."4}

LINKAGE_CODE_ITEM_NAME_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeItemName is invalid."4}

CURSOR_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Cursor is invalid."4}

LINKAGE_CODE_ITEM_INVALID_ENABLED(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Linkage code item's enabled can be up to 1 true."4}

LINKAGE_CODE_ITEM_LIMIT_EXCEEDED(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkage code item count(10,000) was exceeded.."4}

HTTP 500

연동 코드 오류

PropertyTypeDescription
code string 

오류 코드

 
description string 

코드 설명

 

Response Example

An internal server(500)

1{2  "code": "INTERNAL_SERVER_ERROR",3  "description": "An internal server error occurred."4}

DomainId does not exist.(404)

1{2  "code": "DOMAIN_ID_NOT_FOUND",3  "description": "domainId does not exist."4}

Linkage code does not exist.(404)

1{2  "code": "LINKAGE_CODE_NOT_FOUND",3  "description": "Linkage code does not exist."4}

Linkage code item cannot be deleted.(500)

1{2  "code": "INTERNAL_SERVER_ERROR",3  "description": "Linkage code item cannot be deleted."4}

Count must be between 1 and 200.(400)

1{2  "code": "OUT_OF_RANGE",3  "description": "count must be between 1 and 200."4}

Linkage code already exists.(409)

1{2  "code": "LINKAGE_CODE_ID_ALREADY_EXIST",3  "description": "Linkage code already exists."4}

Linkage code item already exists.(409)

1{2  "code": "LINKAGE_CODE_ITEM_ID_ALREADY_EXIST",3  "description": "linkageCodeItem already exists."4}

Linkage code item does not exist.(404)

1{2  "code": "LINKAGE_CODE_ITEM_NOT_FOUND",3  "description": "linkageCodeItem does not exist."4}

Access is denied.(403)

1{2  "code": "ACCESS_DENIED",3  "description": "Access is denied"4}

LINKAGE_CODE_KEY_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeKey is invalid."4}

LINKAGE_CODE_KEY_INVALID_SIZE(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkageCodeKey size (30) was exceeded."4}

LINKAGE_CODE_ITEM_KEY_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeItemId is invalid."4}

LINKAGE_CODE_ITEM_KEY_INVALID_SIZE(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkageCodeItemId (100) was exceeded."4}

LINKAGE_CODE_NAME_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeName is invalid."4}

LINKAGE_CODE_ITEM_NAME_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "linkageCodeItemName is invalid."4}

CURSOR_INVALID(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Cursor is invalid."4}

LINKAGE_CODE_ITEM_INVALID_ENABLED(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Linkage code item's enabled can be up to 1 true."4}

LINKAGE_CODE_ITEM_LIMIT_EXCEEDED(400)

1{2  "code": "PARAMETER_INVALID",3  "description": "Maximum linkage code item count(10,000) was exceeded.."4}