Cmdlets for Kintone

Build 24.0.8963

GraphSettings

Update and Query the available Graph Settings in kintone.

Select

The AppId column is required in the WHERE clause. The cmdlet will use the Kintone APIs to filter the results by this column. By default, the cmdlet will process other filters client-side within the cmdlet.

For example, the following queries are processed server side:

SELECT * FROM GraphSettings WHERE AppId = 6
SELECT * FROM GraphSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM GraphSettings WHERE AppId = 6 AND IsPreview = false

Update

For updating the GraphSettings, provide the Reports as an aggregate. The AppId column is required to update the GraphSettings.

UPDATE GraphSettings SET Reports = '{"Graph1":{"chartType":"BAR","chartMode":"PERCENTAGE","name":"Updated_Graph_Name","index":"0","groups":[{"code":"Created_by"}]}}' WHERE AppId = 6

Columns

Name Type ReadOnly References Description
AppId Integer False

The App ID of the kintone application.

Id [KEY] String True

The ID of the graph.

Index String False

The order of the graphs, starting from 0.

Name String False

The name of the graph. The maximum limit is 64 characters. When the lang request parameter is specified, the graph's name in that language will be returned.

PeriodicReport String False

An objects containing the Periodic Reports (External link) options. If the Generate reports periodically option have never been configured, null will be returned.

Sorts String False

An array of objects containing the Sort by options.

Aggregations String False

The type of the Function option.

ChartMode String False

The display mode (External link) of the graph.

ChartType String False

The chart type (External link) of the graph.

FilterCond String False

The record's filter condition in query string format that reflects the Filter option.

Groups String False

The type of the Function option.

Revision String True

The revision number of the App settings.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Lang String

The localized language to retrieve the data.

IsPreview Boolean

By setting this to False, you will be able to retrieve the Graph Settings details of the live App. Default value is true.

Reports String

Only used for performing Update.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963