Get Per Record Notification Settings
Gets the Per Record Notification settings of the App.
For more information, refer to the following article:
Per Record Notification
Method | GET |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/app/notifications/perRecord.json |
URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/notifications/perRecord.json |
Authentication | Password Authentication , API Token Authentication , Session Authentication |
Content-Type | application/json (not needed if specifying the query with a query string) |
Contents
Pre-live Settings
Apps may hold pre-live settings that have not yet been deployed to the live app.
Access the pre-live settings with the below URL.
URL | https://{subdomain}.kintone.com/k/v1/preview/app/notifications/perRecord.json |
---|---|
URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/notifications/perRecord.json |
Permissions
- App Management Permissions are needed.
Request Parameters
Parameter | Value | Required | Description |
---|---|---|---|
app | Integer or String | Yes | The App ID. |
lang | String | Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: Setting Localized Names The response parameter notifications[].filterCond will include the localized option names in the query string.
|
*If the user language setting is set to Use Web browser settings, the settings set in the Accept-Language header will be used. If there is no Accept-Language header, the language set in the Localization settings in the System Administrator's menu will be used.
Sample Request
|
|
XMLHttpRequest
|
|
Response Parameters
Parameter | Type | Description |
---|---|---|
notifications | Array | An array of objects containing data of the Per Record Notification settings. |
notifications[].filterCond | String | The record's filter condition in query string format. For more information, refer to the following document: Query String |
notifications[].title | String | The notification subject that is saved under Summary. |
notifications[].targets | Array | An array of objects containing the recipients of the Per Record Notification. |
notifications[].targets[].entity | Object | An object containing entity details per recipient of the Per Record Notification. |
notifications[].targets[].entity.type | String | The type of the entity the Per Record Notification settings are configured to.
|
notifications[].targets[].entity.code | String | The code of the entity the Per Record Notification settings are configured to. The following entities will return the following values:
guest/ . |
notifications[].targets[].includeSubs | Boolean | The Include affiliated departments setting of the Department. Will always return false unless the notifications[].targets[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection Field.
|
revision | String | The revision number of the App settings. |
Sample Response
|
|