變更應用程式圖表的設定
變更應用程式圖表的設定。
如果您的應用中存在同名圖表,或者更新后的圖表名稱與其他圖表名稱重複,則在運行此 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 |
字串 | 部分條件下必須 | 圖表類型 指定以下值之一:
圖表名稱 指定,則為必填項。 |
reports.圖表名稱 .chartMode |
字串 | 部分條件下必須 | 圖形顯示模式 指定以下值之一:
chartType 當為「BAR」、「COLUMN」、「AREA」或「SPLINE_AREA」時是必需的。 |
reports.圖表名稱 .name |
字串 | 部分條件下必須 | 新圖表名稱 最多指定 64 個字元。 如果要添加圖表,則為必填項,請指定 圖表名稱 與 相同的值。 |
reports.圖表名稱 .index |
數值或字串 | 部分條件下必須 | 圖形排序順序 它按升序排序。 如果 圖表名稱 指定,則為必填項。重複值會導致錯誤。 |
reports.圖表名稱 .groups |
陣列 | 部分條件下必須 | 要分類的項目清單 它們按您指定的順序設置為大、中、小專案。 如果要添加圖表,則為必填項。 您最多可以指定 3 個。 chartType 如果為「PIVOT_TABLE」,則指定兩個或更多。 |
reports.圖表名稱 .groups[].code |
字串 | 部分條件下必須 | 要分類的物料的域代碼 如果 groups 指定,則為必填項。 |
reports.圖表名稱 .groups[].per |
字串 | 部分條件下必須 | 要分類的項目的時間單位 指定以下值之一:
groups[].code 如果在 中指定以下欄位,則為必填項。
groups[].code 可設置的值因 中指定的欄位而異。 |
reports.圖表名稱 .aggregations |
陣列 | 部分條件下必須 | 聚合方法清單 您最多可以指定 10 個。 如果 chartType 是「PIVOT_TABLE」,則只有一個。如果要添加圖表,則為必填項。 |
reports.圖表名稱 .aggregations[].type |
字串 | 部分條件下必須 | 聚合方法的類型 指定以下值之一:
aggregations 指定,則為必填項。 |
reports.圖表名稱 .aggregations[].code |
字串 | 部分條件下必須 | 要聚合的域代碼 如果 aggregations[].type 為「SUM」或「AVERAGE」,則可以指定以下欄位:
aggregations[].type 如果為「MAX」或「MIN」,則可以指定以下欄位:
aggregations[].type 如果不是「COUNT」,則為必填項。 |
reports.圖表名稱 .filterCond |
字串 | 篩選條件 以查詢格式指定。有關查詢格式的詳細資訊,請參閱以下頁面。 如何編寫查詢 如果在添加圖表時省略,則與指定「所有記錄」相同。 如果在更新時省略,則不會變更設置。 如果指定了已刪除的使用者/組織/群組,則返回錯誤。 |
|
reports.圖表名稱 .sorts |
陣列 | 部分條件下必須 | 排序列表 您最多可以指定 3 個。 如果要添加圖表,則為必填項。 |
reports.圖表名稱 .sorts[].by |
字串 | 部分條件下必須 | 排序方式 指定以下值之一:
sorts 指定,則為必填項。 |
reports.圖表名稱 .sorts[].order |
字串 | 部分條件下必須 | 排序順序 指定以下值之一:
sorts 指定,則為必填項。 |
reports.圖表名稱 .periodicReport |
物件 | 可省略 | 設置定期報告 設定計劃報告時,您只能變更以下參數:
|
reports.圖表名稱 .periodicReport.active |
布爾值或字串 | 可省略 | 定期報告的執行情況 指定以下值之一:
如果在更新時省略,則不會變更設置。 |
reports.圖表名稱 .periodicReport.period |
物件 | 部分條件下必須 | 定期報告的聚合間隔 首次設置計劃報告時需要。 更新計劃報告時,請指定與現在相同的設置,或省略這些設置。 |
reports.圖表名稱 .periodicReport.period.every |
字串 | 部分條件下必須 | 定期報告的聚合間隔類型 指定以下值之一:
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 |
字串 | 部分條件下必須 | 執行季度匯總的月份 指定以下值之一:
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 | 數值或字串 | 可省略 | 預期修訂號 如果與實際修訂號不匹配,則會發生錯誤,並且不會變更設置。 如果指定值「-1」或未指定值,則不會驗證修訂號。 |
請求範例
標頭
|
|
有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規範
內文
|
|
回應
屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
revision | 字串 | 更新後應用設置的修訂號 |
reports | 物件 | 圖表資訊 |
reports.圖表名稱 .id |
字串 | 圖表ID |
示例回應
|
|
示例代碼
使用 curl 的請求
|
|
kintone.api()
請求使用
有關詳細的kintone.api()
,請參閱以下頁面。
發送kintone REST API請求
|
|