Obtener la configuración general de notificaciones

Documentos de API

Obtener la configuración general de notificaciones

Obtiene el atributo Notificación general configuración de la aplicación.

Método	GET
URL	https://{subdomain}.kintone.com/k/v1/app/notifications/general.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/notifications/general.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 hayan 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/general.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/notifications/general.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.

Solicitud de muestra

JavaScript using kintone.api()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


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

kintone.api(kintone.api.url('/k/v1/app/notifications/general.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
17


var appId = kintone.app.getId();
var url = 'https://{subdomain}.kintone.com/k/v1/app/notifications/general.json?app=' + appId;
console.log(url);

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 las opciones "Destinatarios y condiciones". Estas opciones definen quién recibirá las notificaciones.
notifications[].entity	Objeto	Objeto que contiene datos de la entidad en la que está configurada la configuración general de notificación.
notifications[].entity.type	Cuerda	El tipo de entidad en la que está configurada la configuración de notificación general. 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[].entity.code	Cuerda	El código de la entidad en la que está configurada la configuración de notificación general. 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[].includeSubs	Booleano	La configuración "Incluir departamentos afiliados" del Departamento. Siempre volveré `false` a menos que notifications[].entity.type se establezca en ORGANIZATION o FIELD_ENTITY para un campo de selección de departamentos. `true`: Los departamentos afiliados heredan la configuración de notificación general `false`: Los departamentos afiliados no heredan la configuración de notificación general
notifications[].recordAdded	Booleano	Opción para notificar a la entidad cuando se agrega un registro. `true`: Notificar cuando se agrega un registro `false`: No notificar cuando se agrega un registro
notifications[].recordEdited	Booleano	Opción para notificar a la entidad cuando se edita un registro. `true`: Notificar cuando se edita un registro `false`: No notificar cuando se edita un registro
notifications[].commentAdded	Booleano	Opción para notificar a la entidad cuando se publica un comentario. `true`: Notificar cuando se publica un comentario `false`: No notificar cuando se publique un comentario
notifications[].statusChanged	Booleano	Opción para notificar a la entidad cuando se cambia un estado. `true`: Notificar cuando se cambia un estado `false`: No notificar cuando se cambia un estado
notifications[].fileImported	Booleano	Opción para notificar a la entidad cuando se importa un archivo. `true`: Notificar cuando se importa un archivo `false`: No notificar cuando se importa un archivo
notifyToCommenter	Booleano	Opción para notificar a todos los comentaristas de un registro cuando se publica un comentario en ese registro. Esto refleja la casilla de verificación "Enviar notificaciones de comentarios actualizadas a todos los comentaristas". `true`: Notificar a todos los comentaristas del registro cuando se publique un comentario `false`: No notifique a todos los comentaristas del registro cuando se publique un comentario
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": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "includeSubs": false,
      "recordAdded": true,
      "recordEdited": true,
      "commentAdded": false,
      "statusChanged": false,
      "fileImported": true
    }
  ],
  "notifyToCommenter": true,
  "revision": "2"
}