Obtener la configuración de notificaciones de recordatorio

Documentos de API

Obtener la configuración de notificaciones de recordatorio

Obtiene la configuración de notificación de recordatorio de la aplicación. Para obtener más información, consulte el siguiente artículo:
Notificación de recordatorio

Método	GET
URL	https://{subdomain}.kintone.com/k/v1/app/notifications/reminder.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/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 (no es necesario si se especifica la consulta con una cadena de consulta)

Ajustes previos a la transmisión en vivo

Es posible que las aplicaciones contengan configuraciones previas a la transmisión en vivo que aún no se han implementado en la aplicación en vivo.
Acceda a la configuración previa a la transmisión en vivo con la siguiente URL.

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

Permisos

Se necesitan permisos de administración de aplicaciones.

Parámetros de solicitud

Parámetro	Valor	Obligatorio	Descripción
app	Entero o cadena	Sí	El identificador de la aplicación.
lang	Cuerda		El idioma localizado en el que se recuperarán los datos: default: recupera los nombres predeterminados en: recupera los nombres localizados en inglés zh: recupera los nombres chinos localizados ja: recupera los nombres japoneses localizados user: recupera los nombres localizados en el mismo idioma que la configuración de idioma* en el usuario utilizado para la autenticación. Si se ignora, se recuperarán los nombres predeterminados.

*Si la configuración de idioma del usuario se establece en "Usar la configuración del navegador web", se utilizará la configuración establecida en el encabezado Accept-Language. Si no hay un encabezado Accept-Language, se utilizará el idioma establecido en la configuración de "Localización" en el menú del administrador del sistema.

Solicitud de muestra

JavaScript using kintone.api()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


var body = {
  'app': kintone.app.getId(),
  'lang': 'en'
};

kintone.api(kintone.api.url('/k/v1/app/notifications/reminder.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


var appId = kintone.app.getId();
var url = 'https://{subdomain}.kintone.com/k/v1/app/notifications/reminder.json?app=' + appId + '&lang=en';

var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Parámetros de respuesta

Parámetro	Tipo	Descripció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.
notifications[].timing	Objeto	Un objeto que contiene el tiempo de la notificación de recordatorio.
notifications[].timing.code	Cuerda	El código de campo del campo utilizado para determinar el tiempo de la notificación de recordatorio.
notifications[].timing.daysLater	Cuerda	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. Un valor negativo indica el número de días antes de que el notifications[].timing.code fecha/fechahora.
notifications[].timing.hoursLater	Cuerda	El número de horas después de la notifications[].timing.code datetime, desplazado por díasMás tarde, cuando se envía la notificación de recordatorio. Un valor negativo indica el número de horas antes de que el notifications[].timing.code datetime, desplazado por díasMás tarde. El parámetro solo se devuelve si el parámetro notifications[].timing.code se establece en un parámetro Fecha y hora y se configura la opción "Cuándo" horas antes/después (en lugar de la opción "En" hora).
notifications[].timing.time	Cuerda	La hora a la que se envía la notificación de recordatorio. El parámetro se devuelve si el parámetro notifications[].timing.code se establece en un parámetro fecha o la opción "En" se configura la hora.
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 documento: Cadena de consulta Se producirá un error en la solicitud si se especifica un usuario, grupo u organización eliminados en la condición de filtro.
notifications[].title	Cuerda	El asunto de la notificación que se guarda en "Resumen".
notifications[].targets	Arreglo	Matriz de objetos que contiene los destinatarios de la notificación de recordatorio.
notifications[].targets[].entity	Objeto	Un objeto que contiene detalles de la entidad por destinatario de la notificación de recordatorio.
notifications[].targets[].entity.type	Cuerda	El tipo de entidad en la que se configura la configuración de notificación de recordatorio. USER: Usuario GROUP: Grupo ORGANIZATION: Departamento FIELD_ENTITY: Creado por, Actualizado por, Selección de usuarios, Selección de grupos y Campos de selección de departamentos
notifications[].targets[].entity.code	Cuerda	El código de la entidad en la que están configurados los ajustes de notificación de recordatorio. FIELD_ENTITY: El código de campo del campo Para todas las demás entidades: El código del usuario, grupo o departamentoEn el caso de los usuarios invitados, el nombre de inicio de sesión va precedido de guest/.
notifications[].targets[].includeSubs	Booleano	La configuración "Incluir departamentos afiliados" del Departamento. Siempre volveré `false` a menos que el notifications[].targets[].entity.type se establece en ORGANIZATION o FIELD_ENTITY para un campo de selección de departamentos. `true`: Los departamentos afiliados heredan la configuración de notificación de recordatorio `false`: Los departamentos afiliados no heredan la configuración de notificación de recordatorio
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 devolverá null.
revision	Cuerda	El número de revisión de la configuración de la aplicación.

Ejemplo de respuesta

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42


{
  "notifications": [
    {
      "timing": {
        "code": "Deadline_Date",
        "daysLater": "-1",
        "time": "09:00"
      },
      "filterCond": "User_selection in (\" USER\", \"user1\")",
      "title": "Reminder: Tomorrow is the deadline",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    },
    {
      "timing": {
        "code": "Created_datetime",
        "daysLater": "1",
        "hoursLater": "2"
      },
      "filterCond": "User_selection in (\" USER\", \"user1\")",
      "title": "Reminder: Yesterday's records",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    }
  ],
  "timezone": "America/Los_Angeles",
  "revision": "2"
}