PUT/directory/profile-statuses/{profileStatusId}

상태 정보를 수정한다.
기본 상태(BUSY, AWAY, LEAVE_OFFICE, ABSENCE)는 useDefaultStatus, enableSettingByUser, displayOrder 만 수정이 가능하다.
기본 상태에 그 외의 값들은 반영되지 않는다.

Authorization

oauth2

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

Scope

directory

HTTP Request

PUThttps://www.worksapis.com/v1.0/directory/profile-statuses/{profileStatusId}

Path Parameters

ParameterTypeDescription
profileStatusId string 

상태 ID
BUSY (바쁨) , AWAY (자리비움), LEAVE_OFFICE(퇴근), ABSENCE(부재), CUSTOM01~CUSTOM12(커스텀상태)


required
Allowed values : BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01, CUSTOM02, CUSTOM03, CUSTOM04, CUSTOM05, CUSTOM06, CUSTOM07, CUSTOM08, CUSTOM09, CUSTOM10, CUSTOM11, CUSTOM12
example : BUSY 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
domainId integer 

도메인 ID


required
format : int32 
iconType string 

아이콘 타입

iconTypeimageiconTypeimage
BUSYALT​AT_OFFICE​ALT
URGENTALT ​EDUCATION​ALT
FOCUS_MODE​ALTWORKING_OUTSIDE​ALT
PHONE​ALTBUSINESS_TRIP​ALT
MEETING​ALTOFF​ALT
AWAY​ALTHALF_DAY​ALT
BACK_SOON​ALTVACATION​ALT
EATING​ALTABSENCE​ALT
TEA_TIME​ALTSICK_LEAVE​ALT
AT_HOME​ALTLEAVE_OF_ABSENCE​ALT
ACTION​ALTONLINE​ALT

required
Allowed values : BUSY, URGENT, FOCUS_MODE, PHONE, MEETING, AWAY, BACK_SOON, EATING, TEA_TIME, AT_HOME, AT_OFFICE, EDUCATION, WORKING_OUTSIDE, BUSINESS_TRIP, OFF, HALF_DAY, VACATION, ABSENCE, SICK_LEAVE, LEAVE_OF_ABSENCE, ACTION, ONLINE 
useDefaultStatus boolean 

기본 상태 사용 여부

  • true: 기본 상태를 사용
  • false: 기본 상태를 사용 안함
  • 커스텀 상태는 true/false 값을 설정해도 항상 true로 해당 설정의 영향을 받지 않는다.

default : true 
enableSettingByUser boolean 

서비스에서 사용자가 상태 설정 가능 여부


default : true 
profileStatusName string 

상태 이름

  • 기본 상태는 이름 변경이 불가능하다.
  • 다른 상태와 중복된 이름을 허용하지 않는다.

required
maxLength : 20 
i18nNames array (i18nName) 

다국어 이름

  • 기본 상태는 다국어 이름 변경이 불가능하다.
  • 다른 상태와 중복된 다국어 이름을 허용하지 않는다.
  • 같은 상태의 다국어 이름은 중복이 가능하다.

minItems : 0 
displayOrder integer 

상태 순서

  • 0보다 큰 양수 값이어야 한다.
  • 상태끼리 중복된 값을 허용하지 않는다.

required
minimum : 1
format : int32 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
maxLength : 20 
language string 

다국어 언어 코드


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

Request Example

example

1{2  "domainId": 10000001,3  "iconType": "TEA_TIME",4  "enableSettingByUser": true,5  "profileStatusName": "티타임",6  "i18nNames": [7    {8      "name": "TEA TIME",9      "language": "en_US"10    }11  ],12  "displayOrder": 113}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

도메인 ID


required
format : int32 
profileStatusId string 

상태 ID

  • 기본 상태 : BUSY(바쁨) , AWAY(자리비움), LEAVE_OFFICE(퇴근), ABSENCE(부재)
  • 커스텀 상태: CUSTOM01~CUSTOM12

required
Allowed values : BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01, CUSTOM02, CUSTOM03, CUSTOM04, CUSTOM05, CUSTOM06, CUSTOM07, CUSTOM08, CUSTOM09, CUSTOM10, CUSTOM11, CUSTOM12 
iconType string 

아이콘 타입

iconTypeimageiconTypeimage
BUSYALT​AT_OFFICE​ALT
URGENTALT ​EDUCATION​ALT
FOCUS_MODE​ALTWORKING_OUTSIDE​ALT
PHONE​ALTBUSINESS_TRIP​ALT
MEETING​ALTOFF​ALT
AWAY​ALTHALF_DAY​ALT
BACK_SOON​ALTVACATION​ALT
EATING​ALTABSENCE​ALT
TEA_TIME​ALTSICK_LEAVE​ALT
AT_HOME​ALTLEAVE_OF_ABSENCE​ALT
ACTION​ALTONLINE​ALT

required
Allowed values : BUSY, URGENT, FOCUS_MODE, PHONE, MEETING, AWAY, BACK_SOON, EATING, TEA_TIME, AT_HOME, AT_OFFICE, EDUCATION, WORKING_OUTSIDE, BUSINESS_TRIP, OFF, HALF_DAY, VACATION, ABSENCE, SICK_LEAVE, LEAVE_OF_ABSENCE, ACTION, ONLINE 
useDefaultStatus boolean 

기본 상태 사용 여부

  • true: 기본 상태를 사용
  • false: 기본 상태를 사용 안함
  • 커스텀 상태는 true/false 값을 설정해도 항상 true로 해당 설정의 영향을 받지 않는다.

default : true 
enableSettingByUser boolean 

서비스에서 사용자가 상태 설정 가능 여부


default : true 
profileStatusName string 

상태 이름

  • 기본 상태는 이름 변경이 불가능하다.
  • 다른 상태와 중복된 이름을 허용하지 않는다.

required
maxLength : 20 
i18nNames array (i18nName) 

다국어 이름

  • 기본 상태는 다국어 이름 변경이 불가능하다.
  • 다른 상태와 중복된 다국어 이름을 허용하지 않는다.
  • 같은 상태의 다국어 이름은 중복이 가능하다.

minItems : 0 
displayOrder integer 

상태 순서

  • 0보다 큰 양수 값이어야 한다.
  • 상태끼리 중복된 값을 허용하지 않는다.

required
minimum : 1
format : int32 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
maxLength : 20 
language string 

다국어 언어 코드


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

Response Example

example

1{2  "domainId": 10000001,3  "profileStatusId": "CUSTOM01",4  "iconType": "TEA_TIME",5  "useDefaultStatus": true,6  "enableSettingByUser": true,7  "profileStatusName": "티타임",8  "i18nNames": [9    {10      "name": "TEA TIME",11      "language": "en_US"12    }13  ],14  "displayOrder": 115}

HTTP 403

Forbidden

HTTP 409

Conflict