Configuración de notificación de actualización por registro

Documentos de API

Configuración de notificación de actualización por registro

Actualiza la configuración de notificación por registro de la aplicación. Para obtener más información, consulte el siguiente documento:
Notificaciones por registro

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

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 contiene datos de la configuración de notificación por registro. Si la matriz está vacía, se eliminarán todos los ajustes de notificación por registro. Si se ignora, esta configuración no se cambiará.
notifications[].filterCond	Cuerda	Condicional	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 Obligatorio al especificar el parámetro notifications parámetro.
notifications[].title	Cuerda		El asunto de la notificación se guardó en "Resumen". 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 por registro. Si la matriz está vacía, la notificación por registro no tendrá un destinatario. 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 por registro. Obligatorio al especificar el parámetro notifications parámetro.
notifications[].targets[].entity.type	Cuerda	Condicional	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 Obligatorio al especificar el parámetro entity parámetro.
notifications[].targets[].entity.code	Cuerda	Condicional	El código de la entidad en la que está configurada la configuración de notificación por registro. Especifique el código de campo si el notifications[].targets[].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[].targets[].includeSubs	Booleano		La configuración "Incluir departamentos afiliados" del Departamento. Este parámetro está disponible si notificaciones[].targets[].entity.type se especifica en ORGANIZATION o FIELD_ENTITY. `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 Si se omite, este valor es falso.
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


var body = {
  'app': kintone.app.getId(),
  'notifications': [{
    'filterCond': 'User_selection in ("USER", "user1")',
    'title': 'user1 was selected',
    'targets': [{
      'entity': {
        'type': 'USER',
        'code': 'user1'
      },
      'includeSubs': false
    }]
  }],
  'revision': '2'
};

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


var body = {
  'app': kintone.app.getId(),
  'notifications': [{
    'filterCond': 'User_selection in ("USER", "user1")',
    'title': 'user1 was selected',
    'targets': [{
      'entity': {
        'type': 'USER',
        'code': 'user1'
      },
      'includeSubs': false
    }]
  }],
  '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/perRecord.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"
}