GET/users/{userId}/user-profile-statuses

ユーザーのステータスリストを取得する。
現在のステータスと予約されたステータスは、それぞれ 1 つまで登録されている。

Authorization

oauth2

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

Scope

user
user.read
directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/user-profile-statuses

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{userExternalKey})

required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
userProfileStatuses array (UserProfileStatusResponse) 
 

UserProfileStatusResponse

PropertyTypeDescription
userProfileStatusId string 

ユーザーステータス ID

 
profileStatusId string 

ステータス ID

  • BUSY : 取り込み中
  • AWAY : 離席中
  • LEAVE_OFFICE : 時間外
  • ABSENCE : 不在
  • CUSTOM01 ~ CUSTOM12 : カスタムステータス

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

ステータス名

 
iconUrl string 

アイコン URL

 
scheduleType string 

現在ステータスまたは予約ステータス

  • PRESENT : 現在のステータス
  • RESERVED : 予約ステータス

Allowed values : PRESENT, RESERVED 
statusMessage string 

ステータスメッセージ


maxLength : 50
nullable : true 
startTime string 

開始日時 (形式: YYYY-MM-DDThh:mm:ssTZD)
startTime 値がある場合、endTime は必須。


format : date-time
nullable : true 
endTime string 

終了日時 (形式: YYYY-MM-DDThh:mm:ssTZD)
startTime 値がある場合、endTime は必須。


format : date-time
nullable : true 
autoReplyMail object (autoReplyMail) 

メールの自動応答


nullable : true 

autoReplyMail

PropertyTypeDescription
internal object (internal) 

社内メールの自動応答

 
external object (external) 

外部メールの自動応答

 

internal

PropertyTypeDescription
content string 

内容


maxLength : 300 
sentDirectlyToMe boolean 

メールの宛先 (To) に自分が含まれる場合のみ返信するためのフラグ

 

external

PropertyTypeDescription
content string 

内容


maxLength : 300 
sentDirectlyToMe boolean 

メールの宛先 (To) に自分が含まれる場合のみ返信するためのフラグ

 

Response Example

example

1{2  "statuses": [3    {4      "userProfileStatusId": "uprofile-b785-4aae-c330-01e94337846b",5      "profileStatusId": "BUSY",6      "profileStatusName": "Busy",7      "iconUrl": "https://static.worksmobile.net/static/wm/settings/profile_state/ic-16-busy.png",8      "scheduleType": "PRESENT",9      "statusMessage": "status message1",10      "startTime": "2017-03-16T09:00:00+09:00",11      "endTime": "2017-03-18T18:00:00+09:00",12      "autoReplyMail": {13        "internal": {14          "content": "internal mail content",15          "sentDirectlyToMe": true16        },17        "external": {18          "content": "external mail content",19          "sentDirectlyToMe": false20        }21      }22    },23    {24      "profileStatusId": "ABSENCE",25      "userProfileStatusId": "f716ab8e-0766-4306-c794-01f2d902beaf",26      "profileStatusName": "Absent",27      "iconUrl": "https://static.worksmobile.net/static/wm/settings/profile_state/ic-16-absence.png",28      "scheduleType": "RESERVED",29      "statusMessage": "status message2",30      "startTime": "2050-03-18T09:00:00+09:00",31      "endTime": "2050-03-20T18:00:00+09:00",32      "autoReplyMail": {33        "internal": {34          "content": "internal mail content",35          "sentDirectlyToMe": true36        },37        "external": {38          "content": "external mail content",39          "sentDirectlyToMe": false40        }41      }42    }43  ]44}