Obtener personalización

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

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/app/customize.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/customize.json
Autenticación Autenticación de contraseña, Autenticación de sesión
Content-Typeapplication/json (no es necesario si se especifica la consulta con una cadena de consulta)

Contenido

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

Permisos

  • Se necesita permiso para administrar la aplicación al obtener datos de aplicaciones activas.
  • Se necesita permiso para administrar la aplicación al obtener datos de la configuración previa a la transmisión.
  • Los tokens de API no se pueden usar con esta API.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
app Entero o cadena El identificador de la aplicación.

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var body = {
  'app': 1
};

kintone.api(kintone.api.url('/k/v1/app/customize.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
var url = 'https://{subdomain}.kintone.com/k/v1/app/customize.json?app=1';

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
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 un archivo CSS cargado.
desktop.css[].file.contentType Cuerda El tipo MIME del archivo CSS cargado.
desktop.css[].file.fileKey Cuerda fileKey del archivo CSS cargado.
desktop.css[].file.name Cuerda El nombre del archivo CSS cargado.
desktop.css[].file.size Cuerda El tamaño de bytes del archivo CSS cargado.
desktop.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.
desktop.css[].url Cuerda La dirección URL del archivo CSS.
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.
desktop.js[].file.contentType Cuerda El tipo MIME del archivo JavaScript cargado.
desktop.js[].file.fileKey Cuerda fileKey del archivo JavaScript cargado.
desktop.js[].file.name Cuerda El nombre del archivo JavaScript cargado.
desktop.js[].file.size Cuerda El tamaño de bytes del archivo JavaScript cargado.
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.
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 un archivo CSS cargado.
mobile.css[].file.contentType Cuerda El tipo MIME del archivo CSS cargado.
mobile.css[].file.fileKey Cuerda fileKey del archivo CSS cargado.
mobile.css[].file.name Cuerda El nombre del archivo CSS cargado.
mobile.css[].file.size Cuerda El tamaño de bytes del archivo CSS cargado.
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.
mobile.js Arreglo Una matriz que enumera los datos de los archivos JavaScript.
mobile.js[].file Objeto Objeto que contiene datos de un archivo JavaScript cargado.
mobile.js[].file.contentType Cuerda El tipo MIME del archivo JavaScript cargado.
mobile.js[].file.fileKey Cuerda fileKey del archivo JavaScript cargado.
mobile.js[].file.name Cuerda El nombre del archivo JavaScript cargado.
mobile.js[].file.size Cuerda El tamaño de bytes del archivo JavaScript cargado.
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.
revision Cuerda El número de revisión de la configuración de la aplicación.
scope Cuerda El alcance de la personalización
  • ALL: Afecta a todos los usuarios
  • ADMIN: Afecta solo a los administradores de aplicaciones
  • NONE: Inutilizar

Ejemplo de respuesta

 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
53
54
55
56
{
  "scope": "ALL",
  "desktop": {
    "js": [
      {
        "type": "FILE",
        "file": {
          "fileKey": "2019112507490370F72008A0044AF7A7F1F2ED183D2B27209",
          "name": "Desktop_Script_from_FileUpload.js",
          "contentType": "text/javascript",
          "size": "1364"
        }
      },
      {
        "type": "URL",
        "url": "https://www.example.com/Desktop_Script_from_Link.js"
      }
    ],
    "css": [
      {
        "type": "FILE",
        "file": {
          "fileKey": "201911250749038FE3743EA9A543E185E31AC8900B6A12106",
          "name": "desktop_StyleSheet.css",
          "contentType": "text/css",
          "size": "14"
        }
      }
    ]
  },
  "mobile": {
    "js": [
      {
        "type": "FILE",
        "file": {
          "fileKey": "2019112507490302B0656C293345CF8AE8E79C285381FC101",
          "name": "mobile_Script.js",
          "contentType": "text/javascript",
          "size": "24"
        }
      }
    ],
    "css": [
      {
        "type": "FILE",
        "file": {
          "fileKey": "2019112507490329C6BB8EA0F34B4480D265F086FEB3E9183",
          "name": "mobile_StyleSheet.css",
          "contentType": "text/css",
          "size": "17"
        }
      }
    ]
  },
  "revision": "15"
}