Cmdlets for Kintone

Build 24.0.9060

ReminderNotifications

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

Update

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

UPDATE ReminderNotifications SET Notifications = '[{"timing":{"code":"Updated_datetime","daysLater":-2,"hoursLater":-5},"filterCond":"Record_number = 14","title":"Reminder: Tomorrow is the deadline.","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6

Columns

Name Type ReadOnly References Description
AppId [KEY] Integer False

The App ID of the kintone application.

FilterCond String False

The record's filter condition in query string format.

Title String False

The notification subject that is saved under Summary.

TimingCode [KEY] String False

The field code of the field used to determine the Reminder notification's timing.

TimingDaysLater Integer False

The number of days after the notifications[].timing.code date/datetime when the Reminder notification is sent. A negative value indicates the number of days before the notifications[].timing.code date/datetime.

TimingHoursLater Integer False

The number of hours after the notifications[].timing.code datetime, shifted by daysLater, when the Reminder notification is sent.

TimingTime String False

The time when the Reminder notification is sent. The parameter is returned if the notifications[].timing.code parameter is set to a date field or the

Targets String False

An array of objects containing the recipients of the Reminder Notification.

Revision String True

The revision number of the App settings.

Timezone String False

The timezone that determines the Reminder notification's timing. This reflects the Reminder Time Zone dropdown option. If the App's Reminder Notification settings have never been configured, null will be returned.

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 Reminder Notifications 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