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étodo | PUT |
---|---|
URL | https://{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-Type | application/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 | Sí | 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:
|
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:
|
|
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
|
|
XMLHttpRequest
|
|
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
|
|