Obtener la configuración general

Obtiene la descripción, el nombre, el icono, la revisión y el tema de color de una aplicación.

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/app/settings.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/settings.json
Autenticación Autenticación de contraseña , Autenticación de token de API , 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/settings.json
URL (espacio de invitado) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/settings.json

Permisos

  • Se necesita permiso para ver registros o agregar registros al obtener datos de aplicaciones activas.
  • Los permisos de administración de aplicaciones son necesarios para obtener datos de la configuración previa a la transmisión.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
app Integer o String Obligatorio El identificador de la aplicación.
lang String El idioma localizado en el que se recuperarán los datos:
  • default: recupera los nombres predeterminados
  • en: recupera los nombres localizados en inglés
  • zh: recupera los nombres chinos localizados
  • ja: recupera los nombres japoneses localizados
  • user: recupera los nombres localizados en el mismo idioma que la configuración de idioma** establecida en el usuario utilizado para la autenticación.
Si se ignora, se recuperarán los nombres predeterminados.

*\Si la configuración de idioma del usuario se establece en Usar la configuración del navegador web, se utilizará la configuración establecida en el encabezado Accept-Language. Si no hay ningún encabezado Accept-Language, el idioma establecido en el Localización en el menú del administrador del sistema.

Solicitud de muestra

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

kintone.api(kintone.api.url('/k/v1/app/settings.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
16
var params = '?app=1&lang=en';
var url = 'https://{subdomain}.kintone.com/k/v1/app/settings.json' + params;
console.log(url);
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
name String El nombre de la aplicación.
description String La descripción de la aplicación en formato HTML.
icon Object Objeto que contiene datos del icono de la aplicación.
icon.file Object Objeto que contiene datos de archivos de iconos cargados.
icon.file.contentType String El tipo MIME del archivo de icono cargado.
icon.file.fileKey String fileKey del archivo de icono cargado.
icon.file.name String El nombre del archivo de icono cargado.
icon.file.size String El tamaño de bytes del archivo de icono cargado.
icon.key String El identificador de clave del icono.
Respondió, si se utilizan los iconos preestablecidos dentro de Kintone.
icon.type String El tipo de icono:
  • FILE: Una imagen cargada.
  • PRESET: Un icono preestablecido dentro de Kintone.
theme String El tema del color.
  • WHITE
  • RED
  • BLUE
  • GREEN
  • YELLOW
  • BLACK
Las aplicaciones creadas antes de febrero de 2017 pueden responder con los siguientes temas clásicos:CLIPBOARD, BINDER, PENCIL, CLIPS.
titleField Object El título del registro.
titleField.selectionMode String La opción de El campo que se va a utilizar como título del registro Configuración.
  • AUTO: El Establecer automáticamente opción.
  • MANUAL: El Ajuste manual opción.
titleField.code String El código de campo del campo utilizado como título del registro.
enableThumbnails Boolean El Mostrar miniaturas ajuste.
enableBulkDeletion Boolean El Habilitar la eliminación masiva de registros ajuste.
enableComments Boolean El Habilitar comentarios ajuste.
enableDuplicateRecord Boolean El Habilite la función para "duplicar registro" ajuste.
numberPrecision Object El Precisión de números y cálculos ajuste.
numberPrecision.digits String El Número total de dígitos ajuste.
numberPrecision.decimalPlaces String El Número de decimales para redondear ajuste.
numberPrecision.roundingMode String El Redondeo ajuste
  • HALF_EVEN: Redondear al número par más cercano
  • UP: Rodear
  • DOWN: Redondear hacia abajo
firstMonthOfFiscalYear String El Primer mes del año fiscal ajuste. Se devolverá el número del mes.
revision String El número de revisión de la configuración de la aplicación.

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
{
  "name": "San Francisco Lunch Map",
  "description": "A list of great places to go!",
  "icon": {
    "type": "PRESET",
    "key": "APP60"
  },
  "theme": "WHITE",
    "titleField": {
    "selectionMode": "MANUAL",
    "code": "RecordNumber"
  },
  "enableThumbnails": true,
  "enableBulkDeletion": true,
  "enableComments": true,
  "enableDuplicateRecord": true,
  "numberPrecision": {
    "digits": "16",
    "decimalPlaces": "4",
    "roundingMode": "HALF_EVEN"
  },
  "firstMonthOfFiscalYear": "4",
  "revision": "24"
}