検索
Close
カテゴリー内の他の記事

アプリのグラフ設定の変更

作成日
更新日

アプリのグラフの設定を変更します。
同名のグラフがアプリに存在したり更新後のグラフ名がほかのグラフ名と重複したりする場合、この API を実行するとエラーが発生します。

このAPI は、動作テスト環境のアプリに変更を反映します。
本番環境に変更を反映する場合、このAPI を実行した後に、アプリ設定の運用環境への反映 API を実行してください。

URI

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

ゲストスペースのアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/(スペースの ID)/v1/preview/app/reports.json

HTTP メソッド

PUT

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
app
 数値または文字列 必須
アプリのIDを指定します。
reports オブジェクト 必須
グラフの情報を表すオブジェクトです。
reports.{グラフ名} オブジェクト  

各グラフの設定を表すオブジェクトです。

「{グラフ名}」に更新前のグラフ名を指定します。
存在しないグラフ名を指定した場合は、新規のグラフとして追加します。

グラフを追加、更新するときは、既存のすべてのグラフを「{グラフ名}」に指定する必要があります。
指定しなかった場合はそのグラフが削除されます。
reports.{グラフ名}.chartType 文字列 条件必須
グラフの種類です。
  • BAR: 横棒グラフ
  • COLUMN: 縦棒グラフ
  • PIE: 円グラフ
  • LINE: 折れ線グラフ
  • PIVOT_TABLE: クロス集計表
  • TABLE: 表
  • AREA: 面グラフ
  • SPLINE: 曲線グラフ
  • SPLINE_AREA: 曲線面グラフ

「{グラフ名}」を指定する場合、必須です。
reports.{グラフ名}.chartMode 文字列 条件必須
グラフの表示モードです。
  • NORMAL: 集合 または積み上げなし
  • STACKED: 積み上げ
  • PERCENTAGE: 100%積み上げ
chartType が横棒グラフ（BAR）または縦棒グラフ（COLUMN）の場合、NORMAL は集合を表します。
chartType が面グラフ（AREA）または曲線面グラフ（SPLINE_AREA）の場合、NORMAL は積み上げなしを表します。
chartType が BAR、COLUMN、AREA、SPLINE_AREA のいずれかの場合、chartMode の指定は必須です。
reports.{グラフ名}.name 文字列 条件必須
グラフ名です。
グラフを追加する場合、必須です。追加時の reports.{グラフ名} と同一でない場合、エラーになります。
1文字以上64文字以下で指定してください。
reports.{グラフ名}.index 数値または文字列 条件必須

グラフの並び順です。

グラフはこの値の昇順に並びます。
値が重複しているとエラーになります。

「{グラフ名}」を指定する場合、必須です。
reports.{グラフ名}.groups 配列 条件必須
分類する項目を表すオブジェクトの配列です。

指定した順番に、大項目・中項目・小項目として設定されます。配列の要素は3つまで指定できます。

reports.{グラフ名}.chartType が PIVOT_TABLE かつ、指定されている数が1つ以下の場合はエラーになります。
グラフを追加する場合、必須です。
reports.{グラフ名}.groups[].code 文字列 条件必須

分類する項目のフィールドコードです。
reports.{グラフ名}.groups パラメータを指定する場合、必須です。
reports.{グラフ名}.groups[].per 文字列 条件必須
分類する項目の時間単位です。
  • YEAR: 年単位
  • QUARTER: 四半期単位
  • MONTH: 月単位
  • WEEK: 週単位
  • DAY: 日単位
  • HOUR: 1時間単位
  • MINUTE: 分単位

code に下記のフィールドを指定した場合は必須です。
また code に指定したフィールドによって設定できる値が異なります。

  • 作成日時（すべて）
  • 更新日時（すべて）
  • 日時（すべて）
  • 日付（YEAR, QUARTER, MONTH, WEEK, DAY）
  • 時刻（HOUR, MINUTE）
reports.{グラフ名}.aggregations 配列 条件必須

集計方法を表すオブジェクトの配列です。

配列の要素は10個まで指定できます。
reports.{グラフ名}.chartType が PIVOT_TABLE の場合、1個のみ指定できます。
グラフを追加する場合、必須です。
reports.{グラフ名}.aggregations[].type 文字列 条件必須
集計方法の種類です。
  • COUNT: レコード数
  • SUM: 合計
  • AVERAGE: 平均
  • MAX: 最大
  • MIN: 最小

reports.{グラフ名}.aggregations パラメータを指定する場合、必須です。
reports.{グラフ名}.aggregations[].code 文字列 条件必須
集計対象のフィールドコードです。
type が COUNT 以外の場合に必須です。
type が SUM、AVERAGE の場合は以下のフィールドが指定可能です。
  • 数値
  • 計算（数値, 数値（桁区切り））
  • 計算（時間（時分）,時間（日時分））※TABLEの時のみ対応
  • 数値型のルックアップ
type が MAX、MIN の場合は以下のフィールドが指定可能です。
  • 数値
  • 計算（数値, 数値（桁区切り））
  • 計算（日時, 日付, 時刻, 時間（時分）, 時間（日時分））※TABLEの時のみ対応
  • 日時 ※TABLEの時のみ対応
  • 日付 ※TABLEの時のみ対応
  • 時刻 ※TABLEの時のみ対応
  • 作成日時 ※TABLEの時のみ対応
  • 更新日時 ※TABLEの時のみ対応
  • 数値型のルックアップ
reports.{グラフ名}.filterCond 文字列  
絞り込み条件です。

クエリ形式で表されます。クエリ形式については、次のページを参照してください。
レコードの一括取得（クエリで条件を指定）

追加時に省略した場合は「すべてのレコード」を指定した場合と同じです。
更新時に省略した場合、設定を変更しません。
削除済みのユーザー、組織、グループが指定されている場合はエラーが返却されます。
reports.{グラフ名}.sorts 配列 条件必須

ソートを表すオブジェクトの配列です。

配列の要素は3つまで指定できます。
グラフを追加する場合、必須です。
reports.{グラフ名}.sorts[].by 文字列 条件必須
ソートの対象です。
  • TOTAL: 集計値
  • GROUP1: 大項目
  • GROUP2: 中項目
  • GROUP3: 小項目

reports.{グラフ名}.sorts パラメータを指定する場合、必須です。
reports.{グラフ名}.sorts[].order 文字列 条件必須
ソートの並び順です。
  • ASC: 昇順
  • DESC: 降順

reports.{グラフ名}.sorts パラメータを指定する場合、必須です。
reports.{グラフ名}.periodicReport オブジェクト  
定期レポートの設定です。
定期レポートを設定すると、以下のパラメータ以外は変更できなくなります。
  • reports.{グラフ名}.name
  • reports.{グラフ名}.index
  • reports.{グラフ名}.periodicReport.active

更新時に省略した場合、設定を変更しません。
reports.{グラフ名}.periodicReport.active 真偽値または文字列  
定期レポートの実行状態です。
  • true: 実行中
  • false: 停止中

定期レポート初回設定時に省略した場合は true になります。
更新時に省略した場合、設定を変更しません。
reports.{グラフ名}.periodicReport.period オブジェクト 条件必須

定期レポートの集計間隔です。
定期レポート初回設定時は必須です。
更新時に現在と同じ設定を指定する、または省略しない場合に、エラーになります。
reports.{グラフ名}.periodicReport.period.every 文字列 条件必須
定期レポートの集計間隔の種類です。
  • YEAR: 毎年
  • QUARTER: 毎四半期
  • MONTH: 毎月
  • WEEK: 毎週
  • DAY: 毎日
  • HOUR: 毎時

reports.{グラフ名}.periodicReport.period パラメータを指定する場合、必須です。
reports.{グラフ名}.periodicReport.period.month 数値または文字列 条件必須
集計を実施する月です。
値は 1 から 12 の整数です。
every が YEAR の場合、必須です。
reports.{グラフ名}.periodicReport.period.time 文字列 条件必須
集計を実施する時刻です。
フォーマットは HH:mm 形式です。
every が YEAR、QUARTER、MONTH、WEEK、DAY の場合、必須です。
reports.{グラフ名}.periodicReport.period.pattern 文字列 条件必須
四半期の集計を実施する月です。
  • JAN_APR_JUL_OCT: 1月, 4月, 7月, 10月
  • FEB_MAY_AUG_NOV: 2月, 5月, 8月, 11月
  • MAR_JUN_SEP_DEC: 3月, 6月, 9月, 12月
every が QUARTER の場合、必須です。
reports.{グラフ名}.periodicReport.period.dayOfMonth 文字列 条件必須
集計を実施する日です。
  • 1 から 31 の整数です。
  • END_OF_MONTH: 月末
    ※every が QUARTER、MONTH の時のみ
every が YEAR、QUARTER、MONTH の場合、必須です。
reports.{グラフ名}.periodicReport.period.dayOfWeek 文字列 条件必須
集計を実施する曜日です。
  • SUNDAY
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
every が WEEK の場合、必須です。
reports.{グラフ名}.periodicReport.period.minute 数値または文字列 条件必須
集計を実施する分です。
可能な値は 0、10、20、30、40、50 です。
every が HOUR の場合、必須です。
revision 数値または文字列  

期待するアプリ設定のリビジョン番号です。
指定を省略、または「-1」を指定すると、リビジョンはチェックされません。


ヘッダリクエストの例

PUT /k/v1/preview/app/reports.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

レスポンス

パラメータ

パラメータ名 値の種類 説明
revision 文字列 更新後のアプリ設定のリビジョン番号です。
reports オブジェクト グラフの情報です。
reports.{グラフ名}.id 文字列 グラフのIDです。

 

レスポンスの例

JavaScript サンプル

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

XMLHttpRequest を使ったリクエスト

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

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

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