GET/directory/profile-statuses

ユーザープロフィールのステータスリストを取得する。

  • 最大 10 件のステータスを取得できる。
  • ドメインのステータス設定が有効である必要がある。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

directory
directory.read

HTTP Request

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

Query Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


example : 10000001
format : int32 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
profileStatuses array (ProfileStatus) 

ステータス情報

 

ProfileStatus

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
BUSYALTAT_OFFICEALT
URGENTALTEDUCATIONALT
FOCUS_MODEALTWORKING_OUTSIDEALT
PHONEALTBUSINESS_TRIPALT
MEETINGALTOFFALT
AWAYALTHALF_DAYALT
BACK_SOONALTVACATIONALT
EATINGALTABSENCEALT
TEA_TIMEALTSICK_LEAVEALT
AT_HOMEALTLEAVE_OF_ABSENCEALT
ACTIONALTONLINEALT

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 となり、無効にできない

default : true 
enableSettingByUser boolean 

ユーザーによるステータス指定許可フラグ


default : true 
profileStatusName string 

ステータス名

  • 基本ステータスは変更できない
  • 他のステータスと重複する名前は利用できない

required
maxLength : 20 
i18nNames array (i18nName) 

多国語名

  • 基本ステータスは変更できない
  • 他のステータスと重複する多国語名は利用できない

minItems : 0 
displayOrder integer 

ステータスの表示順

  • 1 以上の整数で指定する
  • 他のステータスと重複する表示順は利用できない

required
minimum : 1
format : int32 

i18nName

PropertyTypeDescription
name string 

多国語名


required
maxLength : 20 
language string 

多言語コード


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

Response Example

example

1{2  "profileStatuses": [3    {4      "domainId": 10000001,5      "profileStatusId": "BUSY",6      "iconType": "BUSY",7      "useDefaultStatus": false,8      "enableSettingByUser": false,9      "profileStatusName": "取り込み中",10      "i18nNames": [11        {12          "name": "BUSY",13          "language": "en_US"14        }15      ],16      "displayOrder": 117    },18    {19      "domainId": 10000001,20      "profileStatusId": "CUSTOM01",21      "iconType": "TEA_TIME",22      "useDefaultStatus": true,23      "enableSettingByUser": false,24      "profileStatusName": "ティータイム",25      "i18nNames": [26        {27          "name": "TEA TIME",28          "language": "en_US"29        }30      ],31      "displayOrder": 232    }33  ]34}

HTTP 403

Forbidden