GET/directory/custom-fields

참고
구성원 커스텀 속성 목록 조회 API로 전환하는 것을 권장한다. 구성원 커스텀 속성에서만 제공되는 신규 기능은 이 API로 조회할 수 없다.

도메인의 사용자 지정 필드 정의를 모두 조회한다.

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/custom-fields

Query Parameters

ParameterTypeDescription
domainId integer 

도메인 ID


example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
customFields array (CustomField) 

사용자 지정 필드 정보

 

CustomField

PropertyTypeDescription
domainId integer 

도메인 ID


required
format : int32 
customFieldId string 

도메인 사용자 지정 필드 리소스 ID. 리소스를 추가하면 자동으로 부여된다.


readOnly : true 
customFieldExternalKey string 

사용자 지정 필드 외부 키. 도메인 내에서 유일해야 한다. 알파벳과 숫자만 허용하고 알파벳으로 시작한다. 대소문자를 구분하지 않는다.

이 값은 수정할 수 없다.


maxLength : 100
nullable : true 
customFieldName string 

사용자 지정 필드 이름. 도메인 내에서 유일해야 한다.


required
maxLength : 20 
customFieldType string 

사용자 지정 필드 타입. 이 값은 수정할 수 없다.

  • STRING: 텍스트
  • LINK: 하이퍼링크

required
Allowed values : STRING, LINK 
displayOrder integer 

정렬 순서. 중복이 허용되며 상대 비교를 통해 오름차순으로 정렬된다. 값을 입력하지 않으면(NULL) 마지막 위치로 지정된다.


format : int32 

Response Example

example

1{2  "customFields": [3    {4      "domainId": 10000001,5      "customFieldId": "customfd-fc09-4a57-ab38-03dc6c425e09",6      "customFieldExternalKey": "CUSTOMFIELDEXT01",7      "customFieldName": "custom01",8      "customFieldType": "LINK",9      "displayOrder": 110    }11  ]12}

HTTP 404

Not Found