Cmdlets for Kintone

Build 24.0.9060

GeneralNotifications

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

Update

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

UPDATE GeneralNotifications SET Notifications = '[{"entity":{"type":"FIELD_ENTITY","code":"Updated_by"},"includeSubs":false,"recordAdded":false,"commentAdded":true}],"notifyToCommenter":true' WHERE AppId = 6

Columns

Name Type ReadOnly References Description
AppId [KEY] Integer False

The App ID of the kintone application.

EntityType String False

The type of the entity the General Notification settings are configured to.

EntityCode [KEY] String False

The code of the entity the General Notification settings are configured to.

IncludeSubs Boolean False

The Include affiliated departments setting of the Department. Will always return false unless the notifications[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection Field.

RecordAdded Boolean False

Option to notify the entity when a record is added.

RecordEdited Boolean False

Option to notify the entity when a record is edited.

CommentAdded Boolean False

Option to notify the entity when a comment is posted.

StatusChanged Boolean False

Option to notify the entity when a status is changed.

FileImported Boolean False

Option to notify the entity when a file is imported.

NotifyToCommenter Boolean False

Option to notify all commenters of a record when a comment is posted on that record. This reflects the Send updated comment notifications to all commenters checkbox.

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
IsPreview Boolean

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

Notifications String

Only used for performing Update.

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