Actualizar la configuración general

Actualiza la descripción, el nombre, el icono, la revisión y el tema de color 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/settings.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/settings.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

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

Parámetro Valor Obligatorio Descripción
app Cuerda El identificador de la aplicación.
name Cuerda El nombre de la aplicación. El límite máximo de caracteres es de 64.
descripción Cuerda La descripción de la aplicación. El límite máximo de caracteres es de 10.000. Se pueden utilizar etiquetas HTML.
icon Objeto Objeto que contiene información del icono de la aplicación.
icon.type Cuerda Condicional El tipo de icono. Especifique una de las siguientes opciones:
  • FILE: Una imagen cargada.
  • PRESET: Un icono preestablecido dentro de Kintone.
Obligatorio, si se va a establecer el parámetro "icon".
icon.key Cuerda Condicional El identificador de clave del icono.
Obligatorio, si el parámetro "icon.type" se establece como "PRESET".
Los iconos preestablecidos tienen identificadores clave que se pueden obtener mediante la siguiente API:
Obtener la configuración general
icon.file Objeto Condicional Objeto que contiene información de los archivos de icono cargados.
Obligatorio, si el parámetro "icon.type" se establece como "FILE".
icon.file.fileKey Cuerda Condicional La clave de archivo del icono.
Para adjuntar un archivo, especifique la clave de archivo respondida al usar la siguiente API:
Subir archivo
El límite máximo de tamaño de archivo es de 800 KB.
Obligatorio, si el parámetro "icon.type" se establece como "FILE".
theme Cuerda El tema Color.
Se puede especificar lo siguiente:
  • WHITE
  • RED
  • BLUE
  • GREEN
  • YELLOW
  • BLACK
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.

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
var body = {
  'app': 1,
  'name': 'APP_NAME',
  'description': 'Here is app description.',
  'icon': {
    'type': 'PRESET',
    'key': 'APP72'
  },
  'theme': 'WHITE'
};

kintone.api(kintone.api.url('/k/v1/preview/app/settings.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
var body = {
  'app': 1,
  'name': 'APP_NAME',
  'description': 'Here is app description.',
  'icon': {
    'type': 'PRESET',
    'key': 'APP72'
  },
  'theme': 'WHITE',
  // 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/settings.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"
}