ユーザーの基本カレンダーの取得

GET/users/{userId}/calendar

ユーザーの基本カレンダーを取得する。

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

calendar
calendar.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/calendar

Path Parameters

ParameterTypeDescription
userIdstring

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

  • ユーザーID(userId)
  • ログインID(email)
  • 自身(me)

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

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required

Response

HTTP 200

OK

PropertyTypeDescription
calendarIdstring

カレンダーID


required
calendarNamestring

カレンダー名


required
maxLength : 50
membersarray (CalendarMember)

共有ユーザーリスト


required
minItems : 0
uniqueItems : true
descriptionstring

カレンダー説明

isPublicboolean

Default : false
公開フラグ

calendarEmailstring

カレンダーの固有メールアドレス
共有カレンダーに予定を登録する際、Organizer.email に入力する値。
例)
"organizer": { "email": "{calendarEmail}" }

CalendarMember

PropertyTypeDescription
idstring

ユーザーID(userId)/組織ID(orgUnitId)/グループID(groupId)


required
typestring

ユーザータイプ

  • USER : ユーザー
  • GROUP : グループ
  • ORGUNIT : チーム(組織)

required
Allowed values : USER, GROUP, ORGUNIT
rolestring

ユーザー権限

  • CALENDAR_EVENT_READ_WRITE : カレンダーおよび予定の管理
  • EVENT_READ_WRITE : 予定の管理
  • EVENT_READ : 予定の詳細の閲覧
  • EVENT_READ_FREE_BUSY : 予定の時間枠のみ閲覧

required
Allowed values : CALENDAR_EVENT_READ_WRITE, EVENT_READ_WRITE, EVENT_READ, EVENT_READ_FREE_BUSY

Response Example

example

1{
2  "calendarName": "calendar",
3  "description": "memo",
4  "members": [
5    {
6      "id": "member1@example.com",
7      "type": "USER",
8      "role": "CALENDAR_EVENT_READ_WRITE"
9    },
10    {
11      "id": "member2@example.com",
12      "type": "USER",
13      "role": "EVENT_READ_WRITE"
14    }
15  ],
16  "calendarEmail": "calendar-96b8-4c74-8277-7953e0b4604a@jp1-groups.example.com",
17  "calendarId": "calendar-96b8-4c74-8277-7953e0b4604a",
18  "isPublic": true
19}

HTTP 403

Forbidden

HTTP 404

Not Found