カテゴリー内の他の記事

リマインダーの条件通知の取得

リマインダーの条件通知を取得する API です。

URI

URI は運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合

https://(サブドメイン名).cybozu.com/k/v1/app/notifications/reminder.json

ゲストスペースのアプリの場合: https://(サブドメイン名).cybozu.com/k/guest/(スペースの ID)/v1/app/notifications/reminder.json

動作テスト環境の設定を取得する場合

https://(サブドメイン名).cybozu.com/k/v1/preview/app/notifications/reminder.json

ゲストスペースのアプリの場合: https://(サブドメイン名).cybozu.com/k/guest/(スペースの ID)/v1/preview/app/notifications/reminder.json

HTTP メソッド

GET

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
app 数値または文字列 必須 アプリのIDを指定します。
lang 文字列   フィールドや選択肢の名前に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
  • 日本語の名称を取得する場合:ja
  • 英語の名称を取得する場合:en
  • 中国語の名称を取得する場合:zh
  • ログインユーザーの言語設定で取得する場合:user*
    *ログインユーザーの言語設定が「Webブラウザの設定にしたがう」の場合、
    Accept-Languageヘッダがあればその設定が反映され、
    Accept-Languageヘッダがなければcybozu.com共通管理の「ローカライズの設定」で設定された言語で取得されます。
  • デフォルトの名称を取得する場合:default
省略すると、デフォルトの名称が取得されます。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「app」と「lang」を指定したリクエストの例は、次のとおりです。

URL にパラメータを含める場合

GET /k/v1/app/notifications/reminder.json?app=1&lang=ja HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

リクエストボディにパラメータを含める場合

ヘッダ

GET /k/v1/app/notifications/reminder.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

ボディ

レスポンスパラメータ

パラメータ名 値の種類 説明
notifications 配列 条件通知の設定を表すオブジェクトの配列です。
notifications[].timing オブジェクト 通知のタイミングを表すオブジェクトです。
notifications[].timing.code 文字列 通知のタイミングの基準日時となるフィールドのフィールドコードです。
notifications[].timing.daysLater 文字列 基準日時から何日後(何日前)に通知するかの設定です。
基準日時より前の場合は、負の整数になります。
notifications[].timing.hoursLater 文字列 基準日時に daysLater を足した日時から、何時間後(何時間前)に通知するかの設定です。
基準日時より前の場合は、負の整数になります。
基準日時となるフィールドが日時を表すフィールドで相対時刻が設定されている場合に返却されます。
notifications[].timing.time 文字列 基準日時に daysLater を足した日付の、何時に通知するかの設定です。
基準日時となる日時を表すフィールドで絶対時刻が設定されている場合か、日付フィールドの場合に返却されます。
notifications[].filterCond 文字列 リマインダーの条件通知を行う条件です。クエリ形式で表されます。
クエリ形式については、次のページを参考にしてください。
レコードの一括取得(クエリで条件を指定)
削除済みのユーザー、組織、グループが指定されている場合はエラーが返却されます。
notifications[].title 文字列 リマインダーの条件通知で通知される内容です。
notifications[].targets 配列 通知先の対象を表す配列です。
notifications[].targets[].entity オブジェクト 通知先の対象を表すオブジェクトです。
notifications[].targets[].entity.type 文字列 通知先の対象の種類です。
  • USER: ユーザー
  • GROUP: グループ
  • ORGANIZATION: 組織
  • FIELD_ENTITY: 作成者・更新者・作業者・ユーザー選択・組織選択・グループ選択フィールド
notifications[].targets[].entity.code 文字列 通知先の対象のコードです。
notifications[].targets[].entity.type の値に応じて、次の値が返却されます。
  • FIELD_ENTITY の場合: 作成者・更新者・作業者・ユーザー選択・組織選択・グループ選択フィールドのフィールドコード
  • それ以外の場合: 通知先の対象
ゲストユーザーの場合、ログイン名の前に「guest/」が付きます。
notifications[].targets[].includeSubs 真偽値 設定を下位組織に継承するかどうかの設定です。
notifications[].targets[].entity.type が ORGANIZATION または FIELD_ENTITY で組織選択フィールドが指定されている場合以外、常に false が返却されます。
  • true: 継承する
  • false: 継承しない
timezone 文字列 リマインド時刻のタイムゾーンです。
リマインダーの条件通知を一度も設定していないアプリの場合は null が返却されます。
revision 文字列 アプリ設定のリビジョン番号です。

 

レスポンスの例

JavaScript サンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト</strong>

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

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

Avatar
hamada

レスポンスパラメータのパラメータ名「notifications[].timing.daysLater」が、同じ内容で2か所に記載があります。
修正をお願いできますでしょうか。

Avatar
cybozu Development team

hamada 様

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

ご指摘いただきありがとうございます。

レスポンスパラメータの表内に「notifications[].timing.daysLater」が重複しておりましたので、修正いたしました。

今後とも cybozu developer network をよろしくお願いいたします。

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