GET/business-support/human-resource/extension-properties

인사 부가 정보 목록을 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

businessSupport.humanResource
businessSupport.humanResource.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/business-support/human-resource/extension-properties

Query Parameters

ParameterTypeDescription
count integer 

목록 개수


default : 20
format : int32 
cursor string 

다음 목록 커서 정보

 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
extensionProperties array (ExtensionProperty) 

부가 정보 목록

 
responseMetaData object (responseMetaData) 
 

ExtensionProperty

PropertyTypeDescription
extensionPropertyId string 

부가 정보 ID


readOnly : true 
extensionPropertyName string 

부가 정보명

 
i18nNames array (i18nNames) 

부가 정보 다국어

 
visible boolean 

부가 정보 노출 여부

 
editable boolean 

부가 정보 수정 여부

 
displayOrder integer 

부가 정보 노출 순서


format : int32 
propertyType string 

부가 정보 종류

  • INPUT: 단문
  • TEXTAREA: 장문
  • DATE: 날짜
  • DROPDOWN: 선택형
  • BOOLEAN: true/false/null

Allowed values : INPUT, TEXTAREA, DATE, DROPDOWN, BOOLEAN 
dropdownItems array (ExtensionPropertyDropdownItem) 

DROPDOWN - Item 정보

 
externalKey string 

부가 정보 외부 키

 

i18nNames

PropertyTypeDescription
language string 

다국어 언어 코드


Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
name string 

부가 정보명

 

ExtensionPropertyDropdownItem

PropertyTypeDescription
displayOrder integer 

부가 정보 - DROPDOWN - 노출 순서


format : int32 
i18nNames array (i18nNames) 

부가 정보 - DROPDOWN - 항목 다국어

 
itemId string 

부가 정보 - DROPDOWN - 항목 ID, 수정 시 필수 항목


readOnly : true 
itemName string 

부가 정보 - DROPDOWN - 항목명

 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 목록 조회 시 사용하는 커서값

 

Response Example

Example 1

1{2  "extensionProperties": [3    {4      "extensionPropertyId": "85d92d8a-e268-461d-992d-8ae268661d1c",5      "extensionPropertyName": "사내 동호회",6      "i18nNames": [7        {8          "language": "ko_KR",9          "name": "사내 동호회"10        }11      ],12      "visible": true,13      "editable": true,14      "displayOrder": 1,15      "propertyType": "DROPDOWN",16      "dropdownItems": [17        {18          "displayOrder": 1,19          "i18nNames": [20            {21              "language": "ko_KR",22              "name": "축구 동호회"23            }24          ],25          "itemId": "ac40a251-6804-4803-80a2-51680448038f",26          "itemName": "축구 동호회"27        },28        {29          "displayOrder": 2,30          "i18nNames": [31            {32              "language": "ko_KR",33              "name": "등산 동호회"34            }35          ],36          "itemId": "8e15737f-eec1-48b9-9573-7feec1e8b90b",37          "itemName": "등산 동호회"38        },39        {40          "displayOrder": 3,41          "i18nNames": [42            {43              "language": "ko_KR",44              "name": "테니스 동호회"45            }46          ],47          "itemId": "615db309-f51e-4d90-9db3-09f51efd90ff",48          "itemName": "테니스 동호회"49        }50      ],51      "externalKey": "EXT-PRO-1"52    }53  ],54  "responseMetaData": {55    "nextCursor": "aGVsbG8gd29ya3BsYWNlIA=="56  }57}

Example 2

1{2  "extensionProperties": [3    {4      "extensionPropertyId": "28f4afff-587c-4ae8-b4af-ff587ceae889",5      "extensionPropertyName": "비상 연락망",6      "i18nNames": [7        {8          "language": "ko_KR",9          "name": "비상 연락망"10        }11      ],12      "visible": true,13      "editable": true,14      "displayOrder": 2,15      "propertyType": "TEXTAREA",16      "dropdownItems": [],17      "externalKey": "EXT-PRO-2"18    }19  ],20  "responseMetaData": {21    "nextCursor": "aGVsbG8gd29ya3BsYWNlIA=="22  }23}