1 件の予定を取得する

目次

1 件の予定を取得する

予定 ID を指定して、1 件の予定の内容を取得します。
繰り返し予定の場合、元の予定が返ります。

URL

クラウド版

https://sample.cybozu.com/g/api/v1/schedule/events/SCHEDULE_ID

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

  • IP_ADDRESS_OR_HOST_NAME:Garoon のインストール先の IP アドレスまたはホスト名
  • INSTALL_IDENTIFER:Garoon のインストール識別子
Windows 環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/schedule/events/SCHEDULE_ID
Linux 環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/schedule/events/SCHEDULE_ID
パスパラメーター
パラメーター名 説明
SCHEDULE_ID 取得する予定の予定 ID

HTTP メソッド

GET

利用できるバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 4.10 以降

必要なアクセス権

  • 予定の閲覧権限

リクエスト

パラメーター

なし

リクエストの例
ヘッダー
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST APIの共通仕様 を参照してください。

レスポンス

処理が成功すると、予定の内容が JSON 形式で返ります。
形式の詳細は スケジュールオブジェクト を確認してください。

レスポンスの例
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
  "id": "123",
  "creator": {
    "id": "1",
    "code": "c000001",
    "name": "Noboru Satoh(Satoh Noboru); Sales Department"
  },
  "createdAt": "2017-09-26T06:25:18Z",
  "updater": {
    "id": "1",
    "code": "c000001",
    "name": "Noboru Satoh(Satoh Noboru); Sales Department"
  },
  "updatedAt": "2017-09-26T06:25:18Z",
  "eventType": "REGULAR",
  "eventMenu": "conference",
  "subject": "Weekly conference",
  "notes": "This is notes.\nYou can write multiple lines.",
  "visibilityType": "PUBLIC",
  "useAttendanceCheck": true,
  "companyInfo": {
    "name": "Cybozu, Inc.",
    "zipCode": "103-xxxx",
    "address": "2-7-1, Nihombashi, Chuo-ku, Tokyo",
    "route": "Nihombashi Sta. - Ginza Line - Shibuya Sta.",
    "routeTime": "18",
    "routeFare": "195",
    "phone": "03-4306-xxxx"
  },
  "attachments": [
    {
      "id": "1",
      "name": "figure.png",
      "contentType": "image/png",
      "size": "64251"
    }
  ],
  "start": {
    "dateTime": "2017-09-27T14:00:00+09:00",
    "timeZone": "Asia/Tokyo"
  },
  "end": {
    "dateTime": "2017-09-27T14:00:00+09:00",
    "timeZone": "Asia/Tokyo"
  },
  "isAllDay": "false",
  "isStartOnly": "false",
  "originalStartTimeZone": "Asia/Tokyo",
  "originalEndTimeZone": "Asia/Tokyo",
  "attendees": [
    {
      "id": "1",
      "code": "c000001",
      "name": "Noboru Satoh(Satoh Noboru); Sales Department",
      "type": "USER",
      "attendanceResponse": {
        "status": "PENDING",
        "comment": "I am going to attend the meeting."
      }
    }
  ],
  "watchers": [
    {
      "id": "1",
      "code": "c000001",
      "name": "Noboru Satoh(Satoh Noboru); Sales Department",
      "type": "USER"
    }
  ],
  "facilities": [
    {
      "id": "1",
      "name": "28F conference room",
      "code": "F001"
    }
  ],
  "facilityUsingPurpose": "Because of the explanation of a new plan.",
  "facilityReservationInfo": {
    "additionalProp1": {
      "type": "SINGLE_LINE_TEXT",
      "value": "Custom field value"
    },
    "additionalProp2": {
      "type": "SINGLE_LINE_TEXT",
      "value": "Custom field value"
    },
    "additionalProp3": {
      "type": "SINGLE_LINE_TEXT",
      "value": "Custom field value"
    }
  },
  "facilityUsageRequests": [
    {
      "status": "APPROVED",
      "facility": {
        "id": "1",
        "name": "28F conference room",
        "code": "F001"
      },
      "approvedBy": {
        "id": "1",
        "code": "c000001",
        "name": "Noboru Satoh(Satoh Noboru); Sales Department"
      },
      "approvedDateTime": "2017-09-26T06:25:18Z"
    }
  ],
  "repeatInfo": {
    "type": "EVERY_DAY",
    "period": {
      "start": "2017-04-01",
      "end": "2018-03-31"
    },
    "time": {
      "start": "09:00",
      "end": "18:00"
    },
    "isAllDay": false,
    "isStartOnly": false,
    "timeZone": "Asia/Tokyo",
    "dayOfWeek": "MON",
    "dayOfMonth": "EOM",
    "exclusiveDateTimes": [
      {
        "start": "2017-12-28T00:00:00+09:00",
        "end": "2017-12-29T00:00:00+09:00"
      }
    ]
  },
  "temporaryEventCandidates": [
    {
      "end": {
        "dateTime": "2017-06-06T09:00:00+09:00",
        "timeZone": "Asia/Tokyo"
      },
      "start": {
        "dateTime": "2017-06-06T10:00:00+09:00",
        "timeZone": "Asia/Tokyo"
      },
      "facility": {
        "id": "1",
        "code": "room-a",
        "name": "ROOM-A"
      }
    }
  ],
  "additionalItems": { // パッケージ版 Garoon 6.0 より前のバージョンでのみ利用できます
    "item": {
      "value": "string"
    }
  }
}

additionalItems は、パッケージ版 Garoon 6.0 より前のバージョンでのみ利用できます。
予定に関する付加情報を保存する場合は、カスタマイズ項目(Schedule Datastore)を利用してください。
詳細は、次のページを参照してください。
カスタム項目(additionalItems)の廃止について

サンプルコード

curlを使ったリクエスト
1
2
curl -X GET 'https://sample.cybozu.com/g/api/v1/schedule/events/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' 
Garoon REST API リクエストを送信する API を使ったリクエスト
1
await garoon.api('/api/v1/schedule/events/1', 'GET', {});