予定を作成します。
リクエスト
HTTPリクエスト
POST https://api.spiral.place/v1/events/パラメータ
パスパラメータ
特になし
クエリパラメータ
特になし
リクエストボディ
| フィールド名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| name | string | ○ | 予定名 文字数 ～ 64文字 |
| description | string | 説明 文字数 ～ 8192文字 |
|
| start_datetime | datetime | ○ | 開始日時 フォーマット YYYY-MM-DDThh:mm:ss+09:00（ISO 8601に定めるフォーマット） 15分単位 秒は切り捨てられます |
| end_datetime | datetime | ○ | 終了日時 フォーマット YYYY-MM-DDThh:mm:ss+09:00（ISO 8601に定めるフォーマット） 15分単位 秒は切り捨てられます start_datetimeより前の日時は指定できません |
| is_all_day | boolean | 終日か | |
| frequency | string | デフォルト'spot' フォーマット spot / yearly / monthly / weekly / daily 指定した繰り返し条件に一致する予定が1件もない場合invalidを返します |
|
| repeat_interval | integer | （繰り返し）繰り返し間隔 許容値：0 ~ 7 |
|
| repeat_days | list | （繰り返し）週ごとや月ごとの特定曜日の繰り返しの場合、その曜日インデックスリスト フォーマット 0:月 / 1:火 / 2:水 / 3:木 / 4:金 / 5:土 / 6:日 「repeat_month_day」とどちらか一方しか指定できません |
|
| repeat_week_index | integer | （月繰り返し）繰り返し曜日の週インデックス 許容値：-1 ~ 4 |
|
| repeat_month_day | integer | （月繰り返し）繰り返し日 フォーマット -1を指定すると月末 「repeat_days」とどちら一方しか指定できません |
|
| repeat_stop_date | date | （繰り返し）繰り返し終了日時 フォーマット YYYY-MM-DD start_datetimeより前の日時は指定できません facilitiesを指定している場合は、start_datetimeより2年以上先の日付は指定できません |
|
| is_public | boolean | 公開予定か（デフォルト:true） | |
| is_opaque | boolean | 非公開の場合に表示する設定になっているか（is_public=falseの場合のみ有効）（デフォルト:true） | |
| facilities | list | 利用施設IDリスト | |
| users | list | ○ | 参加スタッフIDリスト（is_invite=trueの場合は招待スタッフIDリスト・任意） |
| groups | list | 参加スタッフグループIDリスト（is_invite=trueの場合はレスポンスには含まれません） | |
| notify_comment | string | 変更コメント 文字数 ～ 1024文字 |
権限
スコープ
event.manage
APIを利用できるユーザー
スタッフ
レスポンス
プロパティ
「4.4 予定｜SPIRAL PLACE API」のプロパティをご参照ください。