Actualizar la configuración de notificaciones de recordatorio
Actualiza la configuración de notificaciones de recordatorio de la aplicación.
Para obtener más información, consulte el siguiente artículo:
Notificaciones de recordatorio
Esta API actualiza la configuración previa a la puesta en marcha.
Después de usar esta API, use la siguiente API para implementar la configuración en la aplicación activa:
Implementar la configuración de la aplicación
Método | PUT |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/preview/app/notifications/reminder.json |
URL (espacio de invitado) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/notifications/reminder.json |
Autenticación | Autenticación de contraseña, Autenticación de token de API, Autenticación de sesión |
Content-Type | application/json |
Contenido
Permisos
- Se necesitan permisos de administración de aplicaciones.
- A la entidad se le debe conceder el permiso de visualización de registros para que la entidad reciba la notificación.
Parámetros de solicitud
Parámetro | Valor | Obligatorio | Descripción |
---|---|---|---|
app | Entero o cadena | Sí | El identificador de la aplicación. |
notifications | Arreglo | Matriz de objetos que consta de opciones de "Activador de notificación". Estas opciones definen cuándo se enviarán las notificaciones, en qué condiciones y los destinatarios. Si se envía una matriz vacía, se eliminarán todos los destinatarios. Si se ignora este parámetro, no se realizarán cambios en las opciones de "Activador de notificación". |
|
notifications[].timing | Objeto | Condicional | Un objeto que contiene el tiempo de la notificación de recordatorio. Obligatorio al especificar el parámetro notifications parámetro. |
notifications[].timing.code | Cuerda | Condicional | El código de campo del campo utilizado para determinar el tiempo de la notificación de recordatorio. Se puede utilizar el código de campo de los siguientes campos:
|
notifications[].timing.daysLater | Entero o cadena | Condicional | El número de días después de la notifications[].timing.code fecha/fecha y hora en que se envía la notificación de recordatorio. Introduzca un valor negativo para el número de días antes de que el notifications[].timing.code fecha/fechahora. El valor debe estar entre -10000 y 10000. Obligatorio al especificar el parámetro notifications[].timing parámetro. |
notifications[].timing.hoursLater | Entero o cadena | Condicional | El número de horas después de la notifications[].timing.code datetime desplazada por daysLater cuando se envía la notificación de recordatorio. Introduzca un valor negativo para el número de horas antes de que el notifications[].timing.code fecha y hora. El valor debe estar entre -10000 y 10000. Obligatorio al especificar el parámetro notifications[].timing y sin especificar el parámetro notifications[].timing.time parámetro. |
notifications[].timing.time | Cuerda | Condicional | La hora a la que se envía la notificación de recordatorio. Introduzca la hora en HH:MM formato. MM debe ser "00", "10", "20", "30", "40" o "50". Ejemplos: "09:00", "14:30" o "23:50" Obligatorio al especificar el parámetro notifications[].timing y sin especificar el parámetro notifications[].timing.hoursLater parámetro. |
notifications[].filterCond | Cuerda | La condición de filtro del registro en formato de cadena de consulta. Para obtener más información sobre los formatos de consulta, consulte el siguiente artículo: Cadena de consulta Los siguientes casos tendrán el mismo resultado:
|
|
notifications[].title | Cuerda | El asunto de la notificación que se guarda en "Resumen". El límite máximo es de 100 caracteres. Si se omite, el asunto de la notificación será una cadena vacía. |
|
notifications[].targets | Arreglo | Condicional | Matriz de objetos que contiene los destinatarios de la notificación de recordatorio. Obligatorio al especificar el parámetro notifications parámetro. |
notifications[].targets[].entity | Objeto | Condicional | Un objeto que contiene detalles de la entidad por destinatario de la notificación de recordatorio. Obligatorio al especificar el parámetro notifications[].targets parámetro. |
notifications[].targets[].entity.type | Cuerda | Condicional | El tipo de entidad en la que se configura la configuración de notificación de recordatorio.
Obligatorio al especificar el parámetro notifications[].targets[].entity parámetro. |
notifications[].targets[].entity.code | Cuerda | Condicional | El código de la entidad en la que están configurados los ajustes de notificación de recordatorio. Especifique el código de campo si el notifications[].targets[].entity.type se especifica como FIELD_ENTITY. En el caso de los usuarios invitados, el nombre de inicio de sesión va precedido de guest/. Obligatorio al especificar el parámetro notifications[].targets[].entity parámetro. |
notifications[].targets[].includeSubs | Booleano o cadena | La configuración "Incluir departamentos afiliados" del Departamento. Este parámetro está disponible si notifications[].targets[].entity.type se especifica en ORGANIZATION o FIELD_ENTITY.
|
|
timezone | Cuerda | La zona horaria que determina el tiempo de la notificación de recordatorio. Esto refleja la opción desplegable "Zona horaria de recordatorio". Si nunca se han configurado los ajustes de notificación de recordatorio de la aplicación, se utilizará la API que ejecuta la zona horaria del usuario. |
|
revision | Entero o cadena | Especifique el número de revisión de la configuración que se implementará. Se producirá un error en la solicitud si el número de revisión no es la última revisión. La revisión no se comprobará si se ignora este parámetro o se especifica -1. |
Solicitud de muestra
|
|
XMLHttpRequest
|
|
Parámetros de respuesta
Parámetro | Tipo | Descripción |
---|---|---|
revision | Cuerda | El número de revisión de la configuración de la aplicación. |
Ejemplo de respuesta
|
|