Cmdlets for Kintone

Build 24.0.9060

ActionSettings

Update and Query the available Action 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 ActionSettings WHERE AppId = 6
SELECT * FROM ActionSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettings WHERE AppId = 6 AND IsPreview = false

Update

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

UPDATE ActionSettings SET Actions = '{"Action_Z":{"name":"Action_A","index":"0"}}' 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 Action.

Index String False

The order of the Action, starting from 0.

Name String False

The name of the Action.

DestApp String False

The App ID of the copy destination app.

DestCode String False

The App Code of the copy destination app. An empty string is returned if an App Code is not set in the destination app's settings.

Mappings String False

An array of objects containing the Field Mappings options. An empty array is returned if the Field Mappings options are not configured.

Entities String False

An array of objects containing the entities the Action is granted to. This reflects the Available To options. Inactive users and deleted users/departments/groups will not be included in the response.

Revision String False

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

Actions String

Only used for performing Update.

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