Garoon APIドキュメント

予定のコメントを追加または削除する

目次

予定にコメントを追加する

固定リンクがコピーされました

コメント情報をリクエストとして受け取り、コメントを予定に追加し、コメントを追加した予定の情報をレスポンスとして返すAPIです。

API名

固定リンクがコピーされました

ScheduleAddFollows

使用可能なGaroonのバージョン

固定リンクがコピーされました

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

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
follow schedule:ScheduleFollowContentType 1～ 無制限 コメント情報
例
1
2
3

<parameters> 
  <follow event_id="8" content="コメント"></follow> 
</parameters>

レスポンス

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
schedule_event schedule:EventType 0～ 無制限 コメントが追加された予定の情報
例
 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

<returns> 
  <schedule_event id="8" 
   event_type="normal"  
   public_type="public"  
   detail="テスト予定"  
   version="1281493911" 
   timezone="Asia/Tokyo" 
   end_timezone="Asia/Tokyo" 
   allday="false"  
   start_only="false"> 
    <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <member> 
        <user id="1" name="Administrator" order="0"/> 
      </member> 
    </members> 
    <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <datetime start="2010-08-11T01:00:00Z" end="2010-08-11T02:00:00Z"/> 
    </when> 
    <follows xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
      <follow id="1" text="コメント" version="1281493911"> 
        <creator user_id="1" name="Administrator" date="2010-08-11T02:31:51Z" /> 
      </follow> 
    </follows> 
  </schedule_event> 
</returns>

繰り返し予定にコメントを追加する

固定リンクがコピーされました

コメント情報をリクエストとして受け取り、コメントを繰り返し予定に追加し、コメントを追加した繰り返し予定の情報をレスポンスとして返すAPIです。

API名

固定リンクがコピーされました

ScheduleAddFollowsToRepeatEvent

使用可能なGaroonのバージョン

固定リンクがコピーされました

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

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
follow schedule:ScheduleFollowToRepeatEventContentType 1～ 無制限 コメント情報
例
1
2
3

<parameters> 
  <follow event_id="1" date="2010-07-01" content="コメント"></follow> 
</parameters>

レスポンス

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
result schedule:ScheduleAddFollowsToRepeatEventResultType 0～ 無制限 コメントが追加された繰り返し予定の情報
例
 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

<returns> 
  <result> 
    <original id="1" 
     event_type="repeat"  
     public_type="public"  
     plan="予定メニュー"  
     detail="標題(変更)"  
     description="メモ(変更)"  
     version="1281498827" 
     timezone="Asia/Tokyo" 
     end_timezone="Asia/Tokyo" 
     allday="false"  
     start_only="false"> 
      <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <member> 
          <user id="1" name="Administrator" order="0"/> 
        </member> 
      <members> 
      <repeat_info xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <condition type="day" day="0"   
         week="0" start_date="2010-07-01" end_date="2010-07-31" 
         start_time="10:00:00" end_time="11:00:00"/> 
        <exclusive_datetimes> 
          <exclusive_datetime start="2010-07-01T00:00:00+09:00"  
           end="2010-07-02T00:00:00+09:00" /> 
         <exclusive_datetime start="2010-06-17T00:00:00+09:00"  
          end="2010-06-18T00:00:00+09:00" /> 
        </exclusive_datetimes> 
      </repeat_info> 
    </original> 
    <modified id="9" 
     event_type="normal"  
     public_type="public"  
     plan="予定メニュー"  
     detail="標題(変更)"  
     description="メモ(変更)"  
     version="1281498829" 
     timezone="Asia/Tokyo" 
     allday="false"  
     start_only="false"> 
      <members xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <member> 
          <user id="1" name="Administrator" order="0"/> 
        </member> 
      </members> 
      <when xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <datetime start="2010-07-01T01:00:00Z" end="2010-07-01T02:00:00Z"/> 
      </when> 
      <follows xmlns="http://schemas.cybozu.co.jp/schedule/2008"> 
        <follow id="2" text="コメント" version="1281498829"> 
          <creator user_id="1" name="Administrator" date="2010-08-11T03:53:49Z" />
      </follow> 
      </follows> 
    </modified> 
  </result> 
</returns>

予定のコメントを削除する

固定リンクがコピーされました

コメントIDをリクエストとして受け取り、コメントを削除するAPIです。

API名

固定リンクがコピーされました

ScheduleRemoveFollows

使用可能なGaroonのバージョン

固定リンクがコピーされました

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

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
follow_id/text() base:IDType 1～ 無制限 コメントID
例
1
2
3

<parameters> 
  <follow_id>1</follow_id> 
</parameters>

レスポンス

固定リンクがコピーされました

なし