變更應用程式圖表的設定

kintone API文件

變更應用程式圖表的設定

連結已複製

本頁面使用機器翻譯而成。
機器翻譯免責聲明

變更應用程式圖表的設定

連結已複製

變更應用程式圖表的設定。
如果您的應用中存在同名圖表，或者更新后的圖表名稱與其他圖表名稱重複，則在運行此 API 時將出現錯誤。

此 API 可變更測試環境中的應用。
如果要將變更套用到正式環境，請在執行該API之後，執行將應用設置反映到正式環境的API。
將應用設置傳播到正式環境API

URL

連結已複製

常規應用程式: https://sample.cybozu.com/k/v1/preview/app/reports.json
訪客空間的應用程式: https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/reports.json

HTTP 方法

連結已複製

PUT

所需存取權限

連結已複製

應用程式管理權限

請求

連結已複製

參數

參數名稱	類型	必須	說明
app	數值或字串	必須	應用ID
reports	物件	必須	圖表資訊添加或更新圖形時，請在 `reports` 中指定現有圖形。否則，圖表將被刪除。
reports.`圖表名稱`	物件	可省略	每個圖表的設置新增圖表時：指定要添加到的圖形名稱 `圖表名稱`。變更圖表時：在更新為 `圖表名稱` 之前指定圖形的名稱。移除圖表時：不指定要刪除的圖表名稱的屬性。
reports.`圖表名稱`.chartType	字串	部分條件下必須	圖表類型指定以下值之一： `BAR`：橫條圖 `COLUMN`：直條圖 `PIE`：圓形圖 `LINE`：折線圖 `PIVOT_TABLE`：交叉資料表 `TABLE`：表 `AREA`：面積圖 `SPLINE`：曲線圖 `SPLINE_AREA`：曲面圖如果`圖表名稱`指定，則為必填項。
reports.`圖表名稱`.chartMode	字串	部分條件下必須	圖形顯示模式指定以下值之一： `NORMAL`： `chartType` 如果是「BAR」或「COLUMN」，則將 `chartType` 如果是「AREA」或「SPLINE_AREA」：不堆疊 `STACKED`：堆疊 `PERCENTAGE`：百分比堆疊 `chartType` 當為「BAR」、「COLUMN」、「AREA」或「SPLINE_AREA」時是必需的。
reports.`圖表名稱`.name	字串	部分條件下必須	新圖表名稱最多指定 64 個字元。如果要添加圖表，則為必填項，請指定`圖表名稱` 與相同的值。
reports.`圖表名稱`.index	數值或字串	部分條件下必須	圖形排序順序它按升序排序。如果`圖表名稱`指定，則為必填項。重複值會導致錯誤。
reports.`圖表名稱`.groups	陣列	部分條件下必須	要分類的項目清單它們按您指定的順序設置為大、中、小專案。如果要添加圖表，則為必填項。您最多可以指定 3 個。 `chartType` 如果為「PIVOT_TABLE」，則指定兩個或更多。
reports.`圖表名稱`.groups[].code	字串	部分條件下必須	要分類的物料的域代碼如果`groups`指定，則為必填項。
reports.`圖表名稱`.groups[].per	字串	部分條件下必須	要分類的項目的時間單位指定以下值之一： `YEAR`：以年為單位 `QUARTER`：以季度為單位 `MONTH`：以月為單位 `WEEK`：以週為單位 `DAY`：以日為單位 `HOUR`：以小時為單位 `MINUTE`：分鐘單位 `groups[].code` 如果在中指定以下欄位，則為必填項。建立時間更新時間日期與時間日期僅適用於「YEAR」「QUARTER」「MONTH」「WEEK」「DAY」時間：時間：僅適用於「HOUR」和「MINUTE」 `groups[].code` 可設置的值因中指定的欄位而異。
reports.`圖表名稱`.aggregations	陣列	部分條件下必須	聚合方法清單您最多可以指定 10 個。如果`chartType` 是「PIVOT_TABLE」，則只有一個。如果要添加圖表，則為必填項。
reports.`圖表名稱`.aggregations[].type	字串	部分條件下必須	聚合方法的類型指定以下值之一： `COUNT`：記錄數 `SUM`：合計 `AVERAGE`：平均 `MAX`：最大 `MIN`：最小如果`aggregations`指定，則為必填項。
reports.`圖表名稱`.aggregations[].code	字串	部分條件下必須	要聚合的域代碼如果`aggregations[].type` 為「SUM」或「AVERAGE」，則可以指定以下欄位：數值計算（數位）計算（小時） `chartType` 僅當「TABLE」是數位Lookup `aggregations[].type` 如果為「MAX」或「MIN」，則可以指定以下欄位：數值計算（數位）計算（日期和時間、日期、時間、時間） `chartType` 僅當「TABLE」是日期與時間 `chartType` 僅當「TABLE」是日期 `chartType` 僅當「TABLE」是時間 `chartType` 僅當「TABLE」是建立時間 `chartType` 僅當「TABLE」是更新時間 `chartType` 僅當「TABLE」是數位Lookup `aggregations[].type` 如果不是「COUNT」，則為必填項。
reports.`圖表名稱`.filterCond	字串		篩選條件以查詢格式指定。有關查詢格式的詳細資訊，請參閱以下頁面。如何編寫查詢如果在添加圖表時省略，則與指定「所有記錄」相同。如果在更新時省略，則不會變更設置。如果指定了已刪除的使用者／組織／群組，則返回錯誤。
reports.`圖表名稱`.sorts	陣列	部分條件下必須	排序列表您最多可以指定 3 個。如果要添加圖表，則為必填項。
reports.`圖表名稱`.sorts[].by	字串	部分條件下必須	排序方式指定以下值之一： `TOTAL`：匯總值 `GROUP1`：大項目 `GROUP2`：中項目 `GROUP3`：小項目如果`sorts`指定，則為必填項。
reports.`圖表名稱`.sorts[].order	字串	部分條件下必須	排序順序指定以下值之一： `ASC`：遞增 `DESC`：遞減如果`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`：每小時如果`periodicReport.period`指定，則為必填項。
reports.`圖表名稱`.periodicReport.period.month	數值或字串	部分條件下必須	執行聚合的月份指定一個介於 1 和 12 之間的整數。如果`periodicReport.period.every` 為「YEAR」，則為必填項。
reports.`圖表名稱`.periodicReport.period.time	字串	部分條件下必須	一天中要執行聚合的時間格式為「HH：mm」格式。如果`periodicReport.period.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月如果`periodicReport.period.every` 為「QUARTER」，則為必填項。
reports.`圖表名稱`.periodicReport.period.dayOfMonth	字串	部分條件下必須	聚合日期指定以下值之一：從 1 到 31 的整數 `END_OF_MONTH`：月底如果`periodicReport.period.every` 為「QUARTER」或「MONTH」如果`periodicReport.period.every`為「YEAR」、「QUARTER」或「MONTH」，則為必填項。
reports.`圖表名稱`.periodicReport.period.dayOfWeek	字串	部分條件下必須	要進行聚合的星期幾指定以下值之一： `SUNDAY` `MONDAY` `TUESDAY` `WEDNESDAY` `THURSDAY` `FRIDAY` `SATURDAY` 如果`periodicReport.period.every` 為「WEEK」，則為必填項。
reports.`圖表名稱`.periodicReport.period.minute	數值或字串	部分條件下必須	執行聚合的分鐘數指定以下值之一： `0` `10` `20` `30` `40` `50` 如果`periodicReport.period.every` 為「HOUR」，則為必填項
revision	數值或字串	可省略	預期修訂號如果與實際修訂號不匹配，則會發生錯誤，並且不會變更設置。如果指定值「-1」或未指定值，則不會驗證修訂號。

請求範例

標頭

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規範

正文

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117


{
  "app": "1",
  "reports": {
    "初期設定": {
      "chartType": "BAR",
      "chartMode": "NORMAL",
      "name": "初期設定",
      "index": "0",
      "groups": [
        {
          "code": "選項按鈕"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        }
      ],
      "filterCond": "",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        }
      ],
      "periodicReport": null
    },
    "様々なグラフの設定": {
      "chartType": "TABLE",
      "name": "様々なグラフの設定",
      "index": "1",
      "groups": [
        {
          "code": "選項按鈕"
        },
        {
          "code": "建立時間",
          "per": "YEAR"
        },
        {
          "code": "時間",
          "per": "MINUTE"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        },
        {
          "type": "SUM",
          "code": "數值"
        },
        {
          "type": "AVERAGE",
          "code": "計算"
        },
        {
          "type": "MAX",
          "code": "建立時間"
        },
        {
          "type": "MIN",
          "code": "時間"
        }
      ],
      "filterCond": "記錄號碼 = \"1\" and 文字編輯方塊 like \"aaa\"",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        },
        {
          "by": "GROUP1",
          "order": "ASC"
        },
        {
          "by": "GROUP2",
          "order": "DESC"
        }
      ],
      "periodicReport": null
    },
    "定期レポートON": {
      "chartType": "BAR",
      "chartMode": "NORMAL",
      "name": "定期レポートON",
      "index": "2",
      "groups": [
        {
          "code": "選項按鈕"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        }
      ],
      "filterCond": "",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        }
      ],
      "periodicReport": {
        "active": true,
        "period": {
          "every": "QUARTER",
          "pattern": "JAN_APR_JUL_OCT",
          "dayOfMonth": "END_OF_MONTH",
          "time": "23:30"
        }
      }
    }
  },
  "revision": "2"
}

回應

連結已複製

屬性

屬性名稱	類型	說明
revision	字串	更新後應用設置的修訂號
reports	物件	圖表資訊
reports.`圖表名稱`.id	字串	圖表ID

示例回應

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "revision": "2",
  "reports": {
    "初期設定": {
      "id": "7319"
    },
    "様々なグラフの設定": {
      "id": "7321"
    },
    "定期レポートON": {
      "id": "7323"
    }
  }
}

示例代碼

連結已複製

使用 curl 的請求

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120


curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/reports.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": "1",
    "reports": {
      "初期設定": {
        "chartType": "BAR",
        "chartMode": "NORMAL",
        "name": "初期設定",
        "index": "0",
        "groups": [
          {
            "code": "選項按鈕"
          }
        ],
        "aggregations": [
          {
            "type": "COUNT"
          }
        ],
        "filterCond": "",
        "sorts": [
          {
            "by": "TOTAL",
            "order": "DESC"
          }
        ],
        "periodicReport": null
      },
      "様々なグラフの設定": {
        "chartType": "TABLE",
        "name": "様々なグラフの設定",
        "index": "1",
        "groups": [
          {
            "code": "選項按鈕"
          },
          {
            "code": "建立時間",
            "per": "YEAR"
          },
          {
            "code": "時間",
            "per": "MINUTE"
          }
        ],
        "aggregations": [
          {
            "type": "COUNT"
          },
          {
            "type": "SUM",
            "code": "數值"
          },
          {
            "type": "AVERAGE",
            "code": "計算"
          },
          {
            "type": "MAX",
            "code": "建立時間"
          },
          {
            "type": "MIN",
            "code": "時間"
          }
        ],
        "filterCond": "記錄號碼 = \"1\" and 文字編輯方塊 like \"aaa\"",
        "sorts": [
          {
            "by": "TOTAL",
            "order": "DESC"
          },
          {
            "by": "GROUP1",
            "order": "ASC"
          },
          {
            "by": "GROUP2",
            "order": "DESC"
          }
        ],
        "periodicReport": null
      },
      "定期レポートON": {
        "chartType": "BAR",
        "chartMode": "NORMAL",
        "name": "定期レポートON",
        "index": "2",
        "groups": [
          {
            "code": "選項按鈕"
          }
        ],
        "aggregations": [
          {
            "type": "COUNT"
          }
        ],
        "filterCond": "",
        "sorts": [
          {
            "by": "TOTAL",
            "order": "DESC"
          }
        ],
        "periodicReport": {
          "active": true,
          "period": {
            "every": "QUARTER",
            "pattern": "JAN_APR_JUL_OCT",
            "dayOfMonth": "END_OF_MONTH",
            "time": "23:30"
          }
        }
      }
    },
    "revision": "2"
  }'

`kintone.api()`請求使用

有關詳細的kintone.api()，請參閱以下頁面。
發送kintone REST API請求

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119


const body = {
  app: '1',
  reports: {
    初期設定: {
      chartType: 'BAR',
      chartMode: 'NORMAL',
      name: '初期設定',
      index: '0',
      groups: [
        {
          code: '選項按鈕'
        }
      ],
      aggregations: [
        {
          type: 'COUNT'
        }
      ],
      filterCond: '',
      sorts: [
        {
          by: 'TOTAL',
          order: 'DESC'
        }
      ],
      periodicReport: null
    },
    各種圖形設置: {
      chartType: 'TABLE',
      name: '各種圖形設置',
      index: '1',
      groups: [
        {
          code: '選項按鈕'
        },
        {
          code: '建立時間',
          per: 'YEAR'
        },
        {
          code: '時間',
          per: 'MINUTE'
        }
      ],
      aggregations: [
        {
          type: 'COUNT'
        },
        {
          type: 'SUM',
          code: '數值'
        },
        {
          type: 'AVERAGE',
          code: '計算'
        },
        {
          type: 'MAX',
          code: '建立時間'
        },
        {
          type: 'MIN',
          code: '時間'
        }
      ],
      filterCond: '記錄號碼 = "1" and 文字編輯方塊 like "aaa"',
      sorts: [
        {
          by: 'TOTAL',
          order: 'DESC'
        },
        {
          by: 'GROUP1',
          order: 'ASC'
        },
        {
          by: 'GROUP2',
          order: 'DESC'
        }
      ],
      periodicReport: null
    },
    定期レポートON: {
      chartType: 'BAR',
      chartMode: 'NORMAL',
      name: '定期レポートON',
      index: '2',
      groups: [
        {
          code: '選項按鈕'
        }
      ],
      aggregations: [
        {
          type: 'COUNT'
        }
      ],
      filterCond: '',
      sorts: [
        {
          by: 'TOTAL',
          order: 'DESC'
        }
      ],
      periodicReport: {
        active: true,
        period: {
          every: 'QUARTER',
          pattern: 'JAN_APR_JUL_OCT',
          dayOfMonth: 'END_OF_MONTH',
          time: '23:30'
        }
      }
    }
  },
  revision: '2'
};

await kintone.api(kintone.api.url('/k/v1/preview/app/reports.json', true), 'PUT', body);

kintone API文件

變更應用程式圖表的設定

目錄

變更應用程式圖表的設定

URL

HTTP 方法

所需存取權限

請求

參數

請求範例

標頭

正文

回應

屬性

示例回應

示例代碼

使用 curl 的請求

kintone.api()請求使用

`kintone.api()`請求使用