お気に入りAPIで使用するデータの構造
StarDataType
お気に入り情報を表す型です。 お気に入り機能は複数のアプリに対してお気に入りを付けることができます。そのためお気に入りデータでは module_id と item という 2 つのパラメーターでお気に入り対象を特定しています。 module_id がアプリ、item が各アプリのエンティティの ID を表しています。
使用可能な Garoon のバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.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 のバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
データ構造
この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。
値 | 説明 |
---|---|
grn.schedule | スケジュール |
grn.mail | メール |
grn.message | メッセージ |
grn.cabinet | ファイル管理 |
grn.report | マルチレポート |
grn.bulletin | 掲示板 |