Personalización de actualizaciones

Actualiza la configuración de personalización de JavaScript y CSS de una aplicación.

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étodoPUT
URLhttps://{subdomain}.kintone.com/k/v1/preview/app/customize.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/customize.json
Autenticación Autenticación de contraseña , Autenticación de sesión
Content-Typeapplication/json

Contenido

Permisos

  • Solo los administradores de Kintone pueden usar esta API.
  • Se necesitan permisos de administración de aplicaciones.
  • Los tokens de API no se pueden usar con esta API.

Parámetros de solicitud

Los parámetros que se ignoren no se actualizarán.

Parámetro Valor Obligatorio Descripción
app Entero o cadena El identificador de la aplicación.
desktop Objeto Objeto que contiene datos de archivos JavaScript y CSS para el escritorio.
desktop.css Arreglo Una matriz que enumera los datos de los archivos CSS para el escritorio.
desktop.css[].file Objeto Objeto que contiene datos de cargas de archivos CSS.
Especifique, si se selecciona "FILE" para desktop.css[].type . Junto con desktop.css[].url, se pueden especificar hasta 30.
desktop.css[].file.fileKey Cuerda fileKey del archivo CSS.
Para adjuntar un archivo, especifique la clave de archivo que se responde al usar la siguiente API:
Subir archivo
Para conservar los archivos CSS actuales que se adjuntan a la aplicación, especifique las claves de archivo que se responden al usar la siguiente API:
Obtener personalización
desktop.css[].type Cuerda El tipo de punto final del archivo CSS:
  • URL: el archivo CSS se especifica con una URL.
  • ARCHIVO: el archivo CSS se carga en la aplicación.
desktop.css[].url Cuerda La dirección URL del archivo CSS.
Especifique, si se selecciona "URL" para desktop.css[].type . Junto con desktop.css[].file, se pueden especificar hasta 30.
desktop.js Arreglo Una matriz que enumera los datos de los archivos JavaScript.
desktop.js[].file Objeto Objeto que contiene datos de un archivo JavaScript cargado.
Especifique, si se selecciona "FILE" para desktop.js[].type . Junto con desktop.js[].url, se pueden especificar hasta 30.
desktop.js[].file.fileKey Cuerda fileKey del archivo JavaScript.
Para adjuntar un archivo, especifique la clave de archivo que se responde al usar la siguiente API:
Subir archivo
Para conservar los archivos JavaScript actuales que se adjuntan a la aplicación, especifique las claves de archivo que se responden al usar la siguiente API:
Obtener personalización
desktop.js[].type Cuerda El tipo de punto final del archivo JavaScript:
  • URL: el archivo JavaScript se especifica con una URL.
  • FILE: el archivo JavaScript se carga en la aplicación.
desktop.js[].url Cuerda La dirección URL del archivo JavaScript.
Especifique, si se selecciona "URL" para desktop.js[].type . Junto con desktop.js[].file, se pueden especificar hasta 30.
mobile Objeto Un objeto que contiene datos de archivos JavaScript y CSS para dispositivos móviles.
mobile.css Arreglo Una matriz que enumera los datos de los archivos CSS para dispositivos móviles.
mobile.css[].file Objeto Objeto que contiene datos de cargas de archivos CSS.
Especifique, si se selecciona "FILE" para mobile.css[].type . Junto con mobile.css[].url, se pueden especificar hasta 30.
mobile.css[].file.fileKey Cuerda fileKey del archivo CSS.
Para adjuntar un archivo, especifique la clave de archivo que se responde al usar la siguiente API:
Subir archivo
Para conservar los archivos CSS actuales que se adjuntan a la aplicación, especifique las claves de archivo que se responden al usar la siguiente API:
Obtener personalización
mobile.css[].type Cuerda El tipo de punto final del archivo CSS:
  • URL: el archivo CSS se especifica con una URL.
  • FILE: el archivo CSS se carga en la aplicación.
mobile.css[].url Cuerda La dirección URL del archivo CSS.
Especifique, si se selecciona "URL" para mobile.css[].type . Junto con mobile.css[].file, se pueden especificar hasta 30.
mobile.js Arreglo Una matriz que enumera los datos de los archivos JavaScript.
mobile.js[].file Objeto Objeto que contiene datos de cargas de archivos JavaScript.
Especifique, si se selecciona "FILE" para mobile.js[].type . Junto con mobile.js[].url, se pueden especificar hasta 30.
mobile.js[].file.fileKey Cuerda fileKey del archivo JavaScript.
Para adjuntar un archivo, especifique la clave de archivo que se responde al usar la siguiente API:
Subir archivo
Para conservar los archivos JavaScript actuales que se adjuntan a la aplicación, especifique las claves de archivo que se responden al usar la siguiente API:
Obtener personalización
mobile.js[].type Cuerda El tipo de punto final del archivo JavaScript:
  • URL: el archivo JavaScript se especifica con una URL.
  • FILE: el archivo JavaScript se carga en la aplicación.
mobile.js[].url Cuerda La dirección URL del archivo JavaScript.
Especifique, si se selecciona "URL" para mobile.js[].type . Junto con mobile.js[].file, se pueden especificar hasta 30.
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.
scope Cuerda El alcance de la personalización
  • ALL: Afecta a todos los usuarios
  • ADMIN: Afecta solo a los administradores de aplicaciones
  • NONE: Inutilizar

Solicitud de muestra

 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
36
37
38
39
40
41
42
var body = {
  'app': 1,
  'scope': 'ALL',
  'desktop': {
    'js': [
      {
        'type': 'URL',
        'url': 'https://www.example.com/example.js'
      },
      {
        'type': 'FILE',
        'file': {
          'fileKey': 'ddfc8e89-7aa3-4350-b9ab-3a75c9cf46b3'
        }
      }
    ],
    'css': []
  },
  'mobile': {
    'js': [
      {
        'type': 'FILE',
        'file': {
          'fileKey': '20150519023802B3EB762E870645F889B22F9D4F1F3059023'
        }
      },
      {
        'type': 'URL',
        'url': 'https://www.example.com/example-mobile.js'
      }
    ],
    'css': []
  }
};

kintone.api(kintone.api.url('/k/v1/preview/app/customize.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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
var body = {
  'app': 1,
  'scope': 'ALL',
  'desktop': {
    'js': [
      {
        'type': 'URL',
        'url': 'https://www.example.com/example.js'
      },
      {
        'type': 'FILE',
        'file': {
          'fileKey': 'ddfc8e89-7aa3-4350-b9ab-3a75c9cf46b3'
        }
      }
    ],
    'css': []
  },
  'mobile': {
    'js': [
      {
        'type': 'FILE',
        'file': {
          'fileKey': '20150519023802B3EB762E870645F889B22F9D4F1F3059023'
        }
      },
      {
        'type': 'URL',
        'url': 'https://www.example.com/example-mobile.js'
      }
    ],
    'css': []
  },
  // 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/customize.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": "3"
}