獲取應用的圖表設置
獲取應用圖表的設置。
如果您的應用中存在同名圖表,則運行此 API 將導致錯誤。
URL
獲取生產環境的設置時,URL 與獲取測試環境的設置時不同。
如果要獲取生產環境的設置
- 常規應用
- https://sample.cybozu.com/k/v1/app/reports.json
- 建立訪客空間
- https://sample.cybozu.com/k/guest/
GUEST_SPACE_ID
/v1/app/reports.json
獲取操作測試環境的設置
- 常規應用
- 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 方法
GET
所需許可權
- 應用程式管理
請求
參數
參數名稱 | 型 | 必須 | 說明 |
---|---|---|---|
app | 數位或字串 | 必須 | 應用ID |
lang | 字串 | 自選 | 要檢索的名稱的語言 指定欄位或選項的名稱是否設置為 每種語言的名稱 。
|
範例請求(如果要在網址中包含參數 )
URL
https://sample.cybozu.com/k/v1/app/reports.json?app=1&lang=ja
頁眉
|
|
關於請求頭,請參見 kintone REST API的通用規範 。
範例要求(如果要在要求正文中包含參數)
URL
https://sample.cybozu.com/k/v1/app/reports.json
頁眉
|
|
關於請求頭,請參見 kintone REST API的通用規範 。
身體
|
|
回應
財產
屬性名稱 | 型 | 說明 |
---|---|---|
reports | 物件 | 圖形資訊 |
reports.圖形名稱 |
物件 | 每個圖表的資訊圖形名稱 始終返回預設名稱,而不考慮運行 API 的使用者的顯示語言設置。 |
reports.圖形名稱 .chartType |
字串 | 圖表類型
|
reports.圖形名稱 .chartMode |
字串 | 圖形顯示模式
chartType 僅當 "BAR"、"COLUMN"、"AREA" 或 "SPLINE_AREA" 時返回。 |
reports.圖形名稱 .id |
字串 | 圖形ID |
reports.圖形名稱 .name |
字串 | 圖表名稱lang ,則返回執行 API 的使用者的顯示語言名稱。 |
reports.圖形名稱 .index |
字串 | 圖形排序順序 從 0 開始。 |
reports.圖形名稱 .groups |
陣列 | 要分類的項目清單 僅返回設置的專案。順序從上到下:大、中、小專案。 |
reports.圖形名稱 .groups[].code |
字串 | 要分類的物料的域代碼 |
reports.圖形名稱 .groups[].per |
字串 | 要分類的項目的時間單位
groups[].code 僅當在 中指定了以下欄位時才返回。
|
reports.圖形名稱 .aggregations |
陣列 | 聚合方法清單 |
reports.圖形名稱 .aggregations[].type |
字串 | 聚合方法的類型
|
reports.圖形名稱 .aggregations[].code |
字串 | 要聚合的域代碼aggregations[].type 當為「COUNT」時不返回。 |
reports.圖形名稱 .filterCond |
字串 | 篩選條件 它以查詢的形式表示。有關查詢格式, 請參閱如何 編寫查詢。 如果指定了已刪除的使用者/組織/組,則返回錯誤。 |
reports.圖形名稱 .sorts |
陣列 | 排序列表 |
reports.圖形名稱 .sorts[].by |
字串 | 排序方式
|
reports.圖形名稱 .sorts[].order |
字串 | 排序順序
|
reports.圖形名稱 .periodicReport |
物件 | 設置定期報告 如果未配置計劃報表,則返回 null。 |
reports.圖形名稱 .periodicReport.active |
布爾值 | 定期報告的執行情況
|
reports.圖形名稱 .periodicReport.period |
物件 | 定期報告的聚合間隔 |
reports.圖形名稱 .periodicReport.period.every |
字串 | 定期報告的聚合間隔類型
|
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 |
字串 | 執行季度匯總的月份
periodicReport.period.every 是"QUARTER"。 |
reports.圖形名稱 .periodicReport.period.dayOfMonth |
字串 | 聚合日期
periodicReport.period.every 僅當它為"YEAR"、"QUARTER"或"MONTH"時才返回。 |
reports.圖形名稱 .periodicReport.period.dayOfWeek |
字串 | 要進行聚合的星期幾
periodicReport.period.every 僅當為「WEEK」時返回。 |
reports.圖形名稱 .periodicReport.period.minute |
字串 | 執行聚合的分鐘數
periodicReport.period.every 僅當 「HOUR」 時返回。 |
revision | 字串 | 應用設置的修訂號 |
示例回應
|
|
示例代碼
使用 curl 的請求
|
|
發送kintone REST API請求 使用API發送請求
|
|