カテゴリー内の他の記事

お気に入りAPIで使用するデータの構造

フォローする

StarDataType

お気に入り情報を表す型です。 お気に入り機能は複数のアプリに対してお気に入りを付けることができます。そのためお気に入りデータでは module_id と item という二つのパラメーターでお気に入り対象を特定しています。 module_idがアプリ、item が各アプリのエンティティの ID を表しています。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明
@id base:IDType 1 お気に入りID
@module_id star:ModuleIdType 1 アプリケーションID
@item base:NonBlankStringType 1 アイテムID
@subject xsd:string 1 タイトル
@version base:VersionType 1 バージョン

module_idとitemの関係を以下に示します。

module_id 対応するアプリ itemで表される値
grn.schedule スケジュール 予定ID
grn.mail メール メールID
grn.message メッセージ メッセージID
grn.cabinet ファイル管理 ファイルID
grn.report マルチレポート レポートID
grn.bulletin 掲示板 掲示板ID

ModuleIdType

アプリケーションIDとして指定可能な値一覧です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は下記のいずれかです。

説明
grn.schedule スケジュール
grn.mail メール
grn.message メッセージ
grn.cabinet ファイル管理
grn.report マルチレポート
grn.bulletin 掲示板

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

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk