Actualizar la configuración general de notificaciones

Documentos de API

Actualizar la configuración general de notificaciones

Actualiza la configuración general de notificaciones de la aplicación. Para obtener información sobre las notificaciones, consulte el siguiente artículo:
Notificaciones generales

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

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 las opciones "Destinatarios y condiciones". 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 "Destinatarios y condiciones".
notifications[].entity	Objeto	Condicional	Objeto que contiene datos de la entidad en la que está configurada la configuración general de notificación. Obligatorio al especificar el parámetro notifications parámetro.
notifications[].entity.type	Cuerda	Condicional	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 Obligatorio al especificar el parámetro entity parámetro.
notifications[].entity.code	Cuerda	Condicional	El código de la entidad en la que está configurada la configuración de notificación general. Especifique el código de campo si el notifications[].entity.type se especifica como FIELD_ENTITY. En el caso de los usuarios invitados, agregue guest/ antes del nombre de inicio de sesión. Obligatorio al especificar el parámetro entity parámetro.
notifications[].includeSubs	Booleano o cadena		La configuración "Incluir departamentos afiliados" del Departamento. Este parámetro está disponible si notifications[].entity.type se especifica en ORGANIZATION o FIELD_ENTITY. `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 Si se omite, este valor es falso.
notifications[].recordAdded	Booleano o cadena		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 Si se omite, este valor es falso.
notifications[].recordEdited	Booleano o cadena		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 Si se omite, este valor es falso.
notifications[].commentAdded	Booleano o cadena		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 Si se omite, este valor es falso.
notifications[].statusChanged	Booleano o cadena		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 Si se omite, este valor es falso.
notifications[].fileImported	Booleano o cadena		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 Si se omite, este valor es falso.
notifyToCommenter	Booleano o cadena		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 Si se ignora, esta configuración no se cambiará.
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

JavaScript using kintone.api()

 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


var body = {
  'app': kintone.app.getId(),
  'notifications': [{
    'entity': {
      'type': 'USER',
      'code': 'user1'
    },
    'includeSubs': false,
    'recordAdded': true,
    'recordEdited': true,
    'commentAdded': false,
    'statusChanged': false,
    'fileImported': true
  }],
  'notifyToCommenter': true,
  'revision': '2'
};

kintone.api(kintone.api.url('/k/v1/preview/app/notifications/general.json', true), 'PUT', 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
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35


var body = {
  'app': kintone.app.getId(),
  'notifications': [{
    'entity': {
      'type': 'USER',
      'code': 'user1'
    },
    'includeSubs': false,
    'recordAdded': true,
    'recordEdited': true,
    'commentAdded': false,
    'statusChanged': false,
    'fileImported': true
  }],
  'notifyToCommenter': true,
  'revision': '2',
  // CSRF TOKEN: used for all APIs that have an HTTP method of POST, PUT, and DELETE on Kintone.
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

var url = 'https://{subdomain}.kintone.com/k/v1/preview/app/notifications/general.json';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send(JSON.stringify(body));

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

1
2
3


{
  "revision": "2"
}