アプリのグラフの設定を変更します。
同名のグラフがアプリに存在したり更新後のグラフ名がほかのグラフ名と重複したりする場合、この 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 | 文字列 | 条件必須 |
グラフの種類です。
「{グラフ名}」を指定する場合、必須です。 |
reports.{グラフ名}.chartMode | 文字列 | 条件必須 |
グラフの表示モードです。
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[].per | 文字列 | 条件必須 |
分類する項目の時間単位です。
code に下記のフィールドを指定した場合は必須です。
|
reports.{グラフ名}.aggregations | 配列 | 条件必須 |
集計方法を表すオブジェクトの配列です。 配列の要素は10個まで指定できます。
reports.{グラフ名}.chartType が PIVOT_TABLE の場合、1個のみ指定できます。
グラフを追加する場合、必須です。
|
reports.{グラフ名}.aggregations[].type | 文字列 | 条件必須 |
集計方法の種類です。
reports.{グラフ名}.aggregations パラメータを指定する場合、必須です。 |
reports.{グラフ名}.aggregations[].code | 文字列 | 条件必須 |
集計対象のフィールドコードです。
type が COUNT 以外の場合に必須です。
type が SUM、AVERAGE の場合は以下のフィールドが指定可能です。
type が MAX、MIN の場合は以下のフィールドが指定可能です。
|
reports.{グラフ名}.filterCond | 文字列 |
絞り込み条件です。
クエリ形式で表されます。クエリ形式については、次のページを参照してください。 追加時に省略した場合は「すべてのレコード」を指定した場合と同じです。
更新時に省略した場合、設定を変更しません。
削除済みのユーザー、組織、グループが指定されている場合はエラーが返却されます。
|
|
reports.{グラフ名}.sorts | 配列 | 条件必須 |
ソートを表すオブジェクトの配列です。 配列の要素は3つまで指定できます。
グラフを追加する場合、必須です。
|
reports.{グラフ名}.sorts[].by | 文字列 | 条件必須 |
ソートの対象です。
reports.{グラフ名}.sorts パラメータを指定する場合、必須です。 |
reports.{グラフ名}.sorts[].order | 文字列 | 条件必須 |
ソートの並び順です。
reports.{グラフ名}.sorts パラメータを指定する場合、必須です。 |
reports.{グラフ名}.periodicReport | オブジェクト |
定期レポートの設定です。
定期レポートを設定すると、以下のパラメータ以外は変更できなくなります。
更新時に省略した場合、設定を変更しません。 |
|
reports.{グラフ名}.periodicReport.active | 真偽値または文字列 |
定期レポートの実行状態です。
定期レポート初回設定時に省略した場合は true になります。 |
|
reports.{グラフ名}.periodicReport.period | オブジェクト | 条件必須 |
定期レポートの集計間隔です。 |
reports.{グラフ名}.periodicReport.period.every | 文字列 | 条件必須 |
定期レポートの集計間隔の種類です。
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 | 文字列 | 条件必須 |
四半期の集計を実施する月です。
every が QUARTER の場合、必須です。
|
reports.{グラフ名}.periodicReport.period.dayOfMonth | 文字列 | 条件必須 |
集計を実施する日です。
every が YEAR、QUARTER、MONTH の場合、必須です。
|
reports.{グラフ名}.periodicReport.period.dayOfWeek | 文字列 | 条件必須 |
集計を実施する曜日です。
every が WEEK の場合、必須です。
|
reports.{グラフ名}.periodicReport.period.minute | 数値または文字列 | 条件必須 |
集計を実施する分です。
可能な値は 0、10、20、30、40、50 です。
every が HOUR の場合、必須です。
|
revision | 数値または文字列 |
期待するアプリ設定のリビジョン番号です。 |
ヘッダリクエストの例
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 を使ったリクエスト
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。