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

구성원 상태 목록을 조회한다. 각 구성원의 현재 상태와 예약 상태는 최대 1개씩이다.

Authorization

oauth2

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

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
- 메일
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


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 

현재상태 또는 예약중 상태 여부


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 

받는 사람일때만 부재 메일을 발송할지 여부

 

external

PropertyTypeDescription
content string 

내용


maxLength : 300 
sentDirectlyToMe boolean 

받는 사람일때만 부재 메일을 발송할지 여부

 

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}