Cmdlets for Kintone

Build 25.0.9434

GeneralSettings

Update and Query the General 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 GeneralSettings WHERE AppId = 6
SELECT * FROM GeneralSettings WHERE AppId = 6 AND IsPreview = false

Update

You must specify the AppId and IconKey of the GeneralSetting to update.

UPDATE GeneralSettings SET Name = 'UpdatedName', Description = 'Test Description', IconType = 'PRESET', IconKey = 'APP72' WHERE IconKey = 'APP72' AND AppId = 6

Columns

Name Type ReadOnly References Description
AppId [KEY] Integer True

The App ID of the kintone application.

IconKey [KEY] String False

The key identifier of the icon. Responded, if the preset icons within Kintone are used.

IconType String False

The icon type: FILE, PRESET.

IconFile String False

An object containing data of uploaded icon files.

Name String False

The App name.

Description String False

The app description in HTML format.

Theme String False

The color theme.

Revision String True

The revision number of the App settings.

TitleFieldSelectionMode String False

The option of The field to be used as the record title settings: AUTO, MANUAL.

TitleFieldCode String False

The field code of the field used as the title of the record.

EnableBulkDeletion Boolean False

The Enable bulk deletion of records setting.

EnableComments Boolean False

The Enable comments setting.

EnableDuplicateRecord Boolean False

The Enable the feature to

EnableThumbnails Boolean False

The Show thumbnails setting.

FirstMonthOfFiscalYear Integer False

The First month of Fiscal Year setting. The number of the month will be returned.

NumberPrecisionDecimalPlaces Integer False

The Number of Decimal Places to Round setting.

NumberPrecisionDigits Integer False

The Total Number of Digits setting.

NumberPrecisionRoundingMode String False

The Rounding setting: HALF_EVEN, UP, DOWN.

EnableInlineRecordEditing Boolean False

Whether to enable inline editing in the record list

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 General Settings details of the live App. Default value is true.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434