Obtener configuración de notificación por registro

Documentos de API

Obtener configuración de notificación por registro

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

Método	GET
URL	https://{subdomain}.kintone.com/k/v1/app/notifications/perRecord.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/notifications/perRecord.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/perRecord.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/notifications/perRecord.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		Establezca este parámetro si hay campos que contienen varias opciones y se ha establecido la configuración de localización para esos nombres de opción. Para obtener más información, consulte el siguiente artículo: Configuración de nombres localizados El parámetro de respuesta `notifications[].filterCond` incluirá los nombres de las opciones localizadas en la cadena de consulta. 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/perRecord.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/perRecord.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 contiene datos de la configuración de notificación por registro.
notifications[].filterCond	Cuerda	La condición de filtro del registro en formato de cadena de consulta. Para obtener más información, consulte el siguiente documento: Cadena de consulta
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 por registro.
notifications[].targets[].entity	Objeto	Un objeto que contiene detalles de la entidad por destinatario de la notificación por registro.
notifications[].targets[].entity.type	Cuerda	El tipo de entidad en la que está configurada la configuración de notificación por registro. 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á configurada la configuración de notificación por registro. Las siguientes entidades devolverán los siguientes valores: FIELD_ENTITY: El código de campo del campo Para todas las demás entidades: El código del usuario, grupo o departamento En 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 notifications[].targets[].entity.type se establezca en ORGANIZACIÓN o FIELD_ENTITY para un campo de selección de departamentos. `true`: Los departamentos afiliados heredan la configuración de notificación por registro `false`: Los departamentos afiliados no heredan la configuración de notificación por registro
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


{
  "notifications": [
    {
      "filterCond": "User_selection in (\" USER\", \"user1\")",
      "title": "user1 was selected",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    }
  ],
  "revision": "2"
}