カテゴリー内の他の記事

通知APIで使用するデータの構造

フォローする

Index

NotificationType

通知を表す型です。

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

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

データ構造

パラメーター名 パラメーター数 説明 変更履歴
@module_id base:IDType 1 通知のアプリケーションID
  • スケジュール:grn.schedule
  • 施設の利用申請:grn.schedule.facility_approval
  • メッセージ:grn.message
  • 掲示板:grn.bulletin
  • ファイル管理:grn.cabinet
  • 電話メモ:grn.phonemessage
  • メール:grn.mail
  • ワークフロー:grn.workflow
  • マルチレポート:grn.report
  • スペース:grn.space
  • スペースのディスカッション:grn.space.discussion
  • スペースの共有ToDo:grn.space.todo
  • 外部通知:外部通知の設定で登録した順にx.1、x.2、x.3、etc
パッケージバージョン 3.5.0 で追加
  • スペース
  • スペースのディスカッション
  • スペースの共有ToDo
パッケージバージョン 4.2.0 で追加
  • 施設の利用申請
@item base:NonBlankStringType 1 通知ID  
@status notification:StatusType 1 通知の状態  
@is_history xsd:boolean 1 通知の確認状況
  • true:確認済み
  • false:未確認
 
@read_datetime xsd:dateTime 0 ~ 1 通知の確認日時  
@receive_datetime xsd:dateTime 0 ~ 1 通知の受信日時  
@subject xsd:string 0 ~ 1 通知の標題  
@subject_url xsd:string 0 ~ 1 通知の標題URL  
@subject_icon xsd:string 0 ~ 1 通知の標題アイコン  
@abstract xsd:string 0 ~ 1 通知の内容  
@abstract_url xsd:string 0 ~ 1 通知の内容URL  
@abstrct_icon xsd:string 0 ~ 1 通知の内容アイコン  
@sender_name xsd:string 0 ~ 1 通知作成者名  
@sender_id base:IDType 0 ~ 1 通知作成者
  • 1~: ユーザーID
  • 0, -1: 通知作成時点で通知作成者が削除されていた場合
  • -2: 掲示板で差出人が直接入力されている場合

パッケージバージョン 4.6.0 で追加

 

@sender_url xsd:string 0 ~ 1 通知作成者のURL  
@attached xsd:boolean 0 ~ 1
  • true:添付ファイルがある
  • true:添付ファイルが無い
 
@version base:VersionType 0 ~ 1 通知の更新日時のタイムスタンプ  

StatusType

通知の状態を表す型です。

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

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

データ構造

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

説明
create 新規通知を表す
update 更新通知を表す
delete スケジュールの予定が削除された通知を表す

NotificationIdType

通知の識別情報を表す型です。

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

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

データ構造

パラメーター名 パラメーター数 説明 変更履歴
@module_id base:IDType 1 アプリケーションID
  • スケジュール:grn.schedule
  • 施設の利用申請:grn.schedule.facility_approval
  • メッセージ:grn.message
  • 掲示板:grn.bulletin
  • ファイル管理:grn.cabinet
  • 電話メモ:grn.phonemessage
  • メール:grn.mail
  • ワークフロー:grn.workflow
  • マルチレポート:grn.report
  • スペース:grn.space
  • スペースのディスカッション:grn.space.discussion
  • スペースの共有ToDo:grn.space.todo
  • 外部通知:外部通知の設定で登録した順にx.1、x.2、x.3、etc
パッケージバージョン 3.5.0 で追加
  • スペース
  • スペースのディスカッション
  • スペースの共有ToDo
パッケージバージョン 4.2.0 で追加
  • 施設の利用申請
 @item base:NonBlankStringType 1 アプリケーションごとに一意のID
  • スケジュール:event
  • 施設の利用申請:event と faid(施設のID) を「-」で結合した文字列
  • メッセージ:mid
  • 掲示板:aid
  • ファイル管理:fid
  • 電話メモ:mid
  • メール:mid
  • ワークフロー:pid
  • マルチレポート:rid
  • スペース:spid
  • スペースのディスカッション:tid
  • スペースの共有ToDo:tdid
  • 外部通知:通知メールのヘッダ(X-Cybozu-Notify-App-UniqueID)
パッケージバージョン 3.5.0 で追加
  • スペース
  • スペースのディスカッション
  • スペースの共有ToDo
パッケージバージョン 4.2.0 で追加
  • 施設の利用申請

NotificationItemVersionType

通知の更新情報を表す型です。

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

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

データ構造

パラメーター名 パラメーター数 説明
notification_id notification:NotificationIdType 1 通知の識別情報
@version base:VersionType 1 通知の更新日時のタイムスタンプ

NotificationItemVersionResultType

通知の更新情報を表すレスポンス用の型です。

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

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

データ構造

パラメーター名 パラメーター数 説明
notification_id notification:NotificationIdType 1 通知の識別情報
@version base:VersionType 1 通知の更新日時のタイムスタンプ
@operation base:ItemOperationType 1 通知の更新情報

NotificationPersonalProfileType

通知の個人情報を表す型です。

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

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

データ構造

パラメーター名 パラメーター数 説明
@save_notification_duration xsd:positiveInteger 0 ~ 1 「通知一覧」画面での保存期間
  • -1:無期限
@save_notification_history_duration xsd:positiveInteger 0 ~ 1 「確認済みの通知」画面での保存期間
  • -1:無期限

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

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

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