カテゴリー内の他の記事

Garoon スケジュールのカスタム項目(additionalItems)の廃止予定について(2021/04/09)

「cybozu developer network」をご利用いただきましてありがとうございます。

下記の通り、Garoon スケジュールのカスタマイズで利用できる、カスタム項目(additionalItems)(以降、additionalItems)を今後 1 年程度を目処に廃止する予定です。

廃止までに、additionalItems を利用しているソースコードを、カスタム項目(Schedule datastore)(以降、Schedule datastore)を利用するように修正してください。
廃止後は、additionalItems を利用しているスケジュールのカスタマイズが動かなくなります。

Schedule datastore については、2021/05/09 定期のメンテナンスにおける API 更新情報をご確認ください。
API ドキュメントは、2021/05/09 定期メンテナンスまでに公開する予定です。

詳細

背景

Garoon スケジュールには、additionalItems という項目で予定の追加情報を保存できる機能があります。
しかし複数のカスタマイズを適用する場合、additionalItems は同時に利用できませんでした。

この機能に代わるものとして、2021年5月の定期メンテナンスで Schedule datastore がリリースされます。

Schedule datastore を利用すると、複数のカスタマイズを適用した場合でも、競合を気にせずに予定へ追加情報を保存できるようになります。

ご確認いただきたいこと

Garoon スケジュールのカスタマイズにおいて、additionalItems を利用したカスタマイズがないかご確認ください。
cybozu developer network で additionalItems を利用している記事は「関連 Tips」をご確認ください。

additionalItems を利用したカスタマイズを行っている場合は、廃止までに「対応方法」のとおりに対応を行ってください

廃止予定日

2022年後半

※ 廃止日が決まり次第、別途告知記事にてご連絡します。

対応方法

additionalItems を利用したカスタマイズを適用している場合、次の 2 点をご対応お願いいたします。

ソースコードの修正

additionalItems を利用しているソースコードを、Schedule datastore を利用するように修正してください。

データ移行

すでに登録済みの予定については、自動でデータ移行されません。

必要に応じて、予定の additionalItems に保存している情報を、Schedule datastore へ保存するように移行してください。

備考

ご利用環境において、additionalItems を利用しているかのお問い合わせは、サイボウズではお受けしておりません。

関連 Tips

cybozu developer network で additionalItems を利用している記事は次のとおりです。

以下の記事は、additionalItems を利用していましたが、Schedule datastore へ保存するようにプログラムの書き換えています。

 

関連情報

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

Avatar
Yoshiyuki Kuwajima

Schedule datastoreに関してスケジュールのオブジェクト( https://developer.cybozu.io/hc/ja/articles/115005314266 )へ反映されるものと推測しておりますがいつぐらいの予定でしょうか?

Schedule datastore に関する API ドキュメントは、後日公開予定です。

また、2021年5月の定期メンテナンスで Schedule datastore はリリース済みという理解ですが、「additionalItems」は /schedule/eventsのレスポンスJSONに含まれておりましたが「Schedule datastore」もしくは「datastore」はレスポンスに含まれていないようです。本項目をREST APIのレスポンスとして確認する条件(設定が必要など)はございますでしょうか?

 

 

Avatar
cybozu Development team

Kuwajima様

お世話になっております。cybozu developer network事務局です。

Shedule datastore は、/schedule/events のレスポンスには含まれません。
以下のAPIをご利用ください。

 

スケジュールのオブジェクト ページには、event オブジェクト内に含まれるものを記載しているため、
Schedule datastore オブジェクトについては記載をしておりません。
当該ページについては今後ドキュメントの改善を検討させていただきます。

もしまたご不明点ございましたらご連絡ください。
今後ともよろしくお願いいたします。

Avatar
Yoshiyuki Kuwajima

ご回答ありがとうございます。eventオブジェクトに含まれるもの(しかし仕様書の反映がまだ)と勘違いしておりました。専用のエンドポイントにてPost&GetでREST APIからの登録・参照を確認できました。

ちなみに本項目はGaroonのGUIからの登録・参照は出来ず、APIからのみアクセス可能な項目という理解であっておりますでしょうか?

Avatar
cybozu Development team

Yoshiyuki Kuwajima 様

お世話になっております。cybozu developer network 事務局です。

Yoshikawa Kuwajima 様のご認識のとおり、
Schedule datastore は、GUI からは参照、変更できない項目となっております。
先日ご案内した API を使用して操作していただくようお願いいたします。

今後ともどうぞよろしくお願いいたします。

Avatar
Yoshiyuki Kuwajima

不明点について全てクリアになりました。ご回答ありがとうございました。今後ともよろしくお願いいたします。

Avatar
滝 正尊

Garoon SOAP APIを使用しています。

ソースコードの修正の箇所に「Garoon REST API」「Garoon JavaScript API」の対応方法が記載されていますが、Garoon SOAP API では そもそも additionalItems が扱えないため、このアップデートの影響は受けない(修正などの考慮は必要ない)と考えてよいでしょうか?

お手数をおかけして申し訳ありませんが、念のため確認させてください。

Avatar
cybozu Development team

滝様

お世話になっております。cybozu developer network 事務局です。

ご認識のとおり、Garoon SOAP API ではスケジュールのカスタム項目(additionalItems)の廃止による影響はありません。

ご不明点ございましたらご連絡ください。
今後ともよろしくお願いいたします。

Avatar
滝 正尊

cybozu developer network 事務局 ご担当者様

ご回答ありがとうございます。
懸念点が解消できました。

引き続きよろしくお願いいたします。

サインインしてコメントを残してください。