Documentos de API

Implementar la configuración de la aplicación

Actualiza la configuración de una aplicación previa a la transmisión en vivo a la aplicación en vivo.

El uso de esta API da los mismos resultados que cuando los usuarios hacen clic en "Actualizar aplicación" o "Descartar cambios" en la página de configuración de la aplicación.

Si se especifican varias aplicaciones en esta API y se produce un error en una de las actualizaciones de una aplicación, todas las aplicaciones especificadas se revertirán al estado anterior a la ejecución de esta API.

Si se cambian los permisos de registro/campo de las aplicaciones, la configuración actualizada se aplicará a los registros/campos en cuestión de forma secuencial, dentro de cada aplicación.

MétodoPOST
URLhttps://{subdomain}.kintone.com/k/v1/preview/app/deploy.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/deploy.json
Autenticación Autenticación de contraseña, Autenticación de token de API, Autenticación de sesión
Content-Typeapplication/json

Contenido

Permisos

  • Se necesitan permisos de administración de aplicaciones.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
apps Arreglo Sí La lista de aplicaciones para implementar la configuración previa a la puesta en marcha en las aplicaciones activas. El límite máximo es de 300.
Si las aplicaciones se implementan en espacios de invitado, las aplicaciones solo se pueden implementar en el mismo espacio de invitado.
apps[].app Entero o cadena Sí El identificador de la aplicación.
apps[].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 si se especifica -1.
revertir Booleano o cadena Especificar true para cancelar todos los cambios realizados en la configuración previa a la transmisión. La configuración previa a la transmisión en vivo se revertirá a la configuración actual de la aplicación en vivo.

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

var body = {
  'apps': [
    {
      'app': 1,
      'revision': 57
    },
    {
      'app': 1001,
      'revision': 22
    }
  ],
  'revert': true
};

kintone.api(kintone.api.url('/k/v1/preview/app/deploy.json', true), 'POST', 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

var url = 'https://{subdomain}.kintone.com/k/v1/preview/app/deploy.json';
var body = {
  'apps': [
    {
      'app': 1,
      'revision': 57
    },
    {
      'app': 1001,
      'revision': 22
    }
  ],
  'revert': true,
  // CSRF TOKEN: used for all APIs that have an HTTP method of POST, PUT and DELETE on Kintone.
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};
var xhr = new XMLHttpRequest();
xhr.open('POST', 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

Esta API no tiene respuestas.

Ejemplo de respuesta

Esta API no tiene respuestas.

Limitaciones

Si las API para cambiar la configuración de la aplicación se ejecutan durante la implementación (o cancelación), se devolverá un error.