GET/directory/profile-statuses/{profileStatusId}

Gets status information.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

directory
directory.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
profileStatusId string 

Status 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 

Query Parameters

ParameterTypeDescription
domainId integer 

Domain ID


example : 10000001
format : int32 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

Domain ID


required
format : int32 
profileStatusId string 

Status ID.

  • Default status values: BUSY, AWAY, LEAVE_OFFICE, and ABSENCE
  • Custom status values: CUSTOM01-CUSTOM12

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

Icon type

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 

Indicates whether to use the default status values.

  • true: Use the default status values
  • false: Do not use.
  • This parameter does not affect whether to use the custom status values, which is always "true".

default : true 
enableSettingByUser boolean 

Indicates whether to allow users to set their status.


default : true 
profileStatusName string 

Status name

  • The default status values cannot be renamed.
  • A status name must be unique.

required
maxLength : 20 
i18nNames array (i18nName) 

Multilingual name

  • The default status values cannot be renamed.
  • A multilingual status name must be unique among status values.
  • A status value can have duplicated multilingual status names.

minItems : 0 
displayOrder integer 

Display order

  • It must be a positive number.
  • It must be unique among status values.

required
minimum : 1
format : int32 

i18nName

PropertyTypeDescription
name string 

Multilingual name


required
maxLength : 20 
language string 

Language code


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": "Tea time",8  "i18nNames": [9    {10      "name": "TEA TIME",11      "language": "en_US"12    }13  ],14  "displayOrder": 115}

HTTP 403

This API operation is not available when useProfileStatus is "false".