Obtener campos de formulario

Obtiene la lista de campos y la configuración de campos de una aplicación.

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/app/form/fields.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/form/fields.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 hayan 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/form/fields.json
URL (espacio de invitado) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/form/fields.json

Permisos

  • Se necesita permiso para ver registros o agregar registros al obtener datos de aplicaciones activas.
  • Se necesita permiso para administrar la aplicación cuando se obtienen datos de la configuración previa a la transmisión.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
app Integer 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
var body = {
  'app': 1
};

kintone.api(kintone.api.url('/k/v1/app/form/fields.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/form/fields.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
properties Object Un objeto con datos de la configuración del campo.
properties.{fieldcode}.label String El nombre del campo.
properties.{fieldcode}.code String El código de campo.
properties.{fieldcode}.type String El tipo de campo.
  • GROUP: Grupo
  • GROUP_SELECT: Selección de grupos
  • CALC: Calculado
  • CATEGORY: Categoría
  • CHECK_BOX: Casilla de verificación
  • CREATED_TIME: Fecha y hora creada
  • CREATOR: Creado por
  • DATE: Fecha
  • DATETIME: Fecha y hora
  • DROP_DOWN: Menú desplegable
  • FILE: Archivo adjunto
  • LINK: Enlace
  • MODIFIER: Actualizado por
  • MULTI_LINE_TEXT: Área de texto
  • MULTI_SELECT: Opción múltiple
  • NUMBER: Número o Búsqueda*</li>
  • ORGANIZATION_SELECT: Selección de departamentos
  • RADIO_BUTTON: Botón de opción
  • RECORD_NUMBER: Número de registro
  • REFERENCE_TABLE: Registros relacionados
  • RICH_TEXT: Texto enriquecido
  • SINGLE_LINE_TEXT: Texto o Búsqueda*</li>
  • STATUS: Estado de la gestión de procesos
  • STATUS_ASSIGNEE: Persona asignada del status de Gestión de Procesos
  • SUBTABLE: Mesa
  • TIME: Hora
  • UPDATED_TIME: Fecha y hora actualizada
  • USER_SELECT: Selección de usuarios
*El tipo del campo de búsqueda será el mismo que el campo de clave que está buscando.
properties.{fieldcode}.noLabel Boolean La opción Ocultar nombre de campo.
  • true: El nombre del campo está oculto.
  • false: Se muestra el nombre del campo.
properties.{fieldcode}.required String La opción Campo obligatorio.
  • true: El campo es un campo obligatorio.
  • false: El campo no es obligatorio.
properties.{fieldcode}.unique String La opción Prohibir valores duplicados.
  • true: Se prohíben los valores duplicados.
  • false: No se prohíben los valores duplicados.
properties.{fieldcode}.maxValue String El número máximo de caracteres para el campo.
properties.{fieldcode}.minValue String El número mínimo de caracteres para el campo.
properties.{fieldcode}.maxLength String El número máximo de dígitos para el campo.
properties.{fieldcode}.minLength String El número mínimo de dígitos para el campo.
properties.{fieldcode}.defaultValue String o Array El valor predeterminado.
Se devolverá una matriz para los campos que pueden establecer varios valores predeterminados.
properties.{fieldcode}.defaultNowValue String La opción Por defecto a la fecha de creación del registro.
  • true: La fecha de creación del registro se utiliza como valor predeterminado.
  • false: La fecha de creación del registro no se utiliza como valor predeterminado.
properties.{fieldcode}.options Object Un objeto que incluye datos de las opciones del campo.
properties.{fieldcode}.options.{optionname}.label String El nombre de la opción.
properties.{fieldcode}.options.{optionname}.index String El orden de visualización (ascendente) de la opción, cuando aparece con las otras opciones.
properties.{fieldcode}.align String El diseño de las opciones.
  • HORIZONTAL: Las opciones se enumeran horizontalmente.
  • VERTICAL: Las opciones se enumeran verticalmente.
properties.{fieldcode}.expression String Expresión de fórmula utilizada en el campo.
properties.{fieldcode}.hideExpression String La configuración de Ocultar fórmula para el campo.
  • true: La fórmula está oculta.
  • false: Se muestra la fórmula.
properties.{fieldcode}.digit String La opción Usar separadores de miles.
  • true: Se muestran separadores de miles para el número.
  • false: Los separadores de miles no se muestran para el número.
properties.{fieldcode}.thumbnailSize String El tamaño de la miniatura de la imagen en píxeles.
properties.{fieldcode}.protocol String La configuración del tipo de vínculo para el campo.
  • WEB: URL
  • CALL: Número de teléfono
  • MAIL: Dirección de correo electrónico
properties.{fieldcode}.format String El formato de visualización de los campos con cálculos:
  • NUMBER: Número (1000)
  • NUMBER_DIGIT: Número con separador de miles (1.000)
  • DATETIME: Fecha y hora (06 de agosto de 2012 14:03)
  • DATE: Fecha (06 de agosto de 2012)
  • TIME: Hora (2:03 PM)
  • HOUR_MINUTE: Horas y minutos (29 horas 47 minutos)
  • DAY_HOUR_MINUTE: Días, horas y minutos (1 día, 5 horas, 47 minutos)
properties.{fieldcode}.displayScale String El número de decimales que se mostrarán para el campo.
properties.{fieldcode}.unit String La configuración de moneda del campo.
properties.{fieldcode}.unitPosition String La posición de visualización de la moneda.
  • BEFORE: La moneda se muestra antes del valor del campo.
  • AFTER: La moneda se muestra después del valor del campo.
properties.{fieldcode}.entities Array Una matriz que enumera los usuarios preestablecidos para el campo.
properties.{fieldcode}.entities[].code String El código del usuario/grupo/departamento.
properties.{fieldcode}.entities[].type String El tipo de entidad.
  • USER: Usuario
  • GROUP: Grupo
  • ORGANIZATION: Departamento
properties.{fieldcode}.referenceTable Object Objeto que contiene la configuración del campo Registros relacionados.
null se devuelve si no hay permisos de visualización para la aplicación de origen de datos.
properties.{fieldcode}.referenceTable.relatedApp Object Un objeto que contiene datos de la configuración Aplicación de origen de datos.
properties.{fieldcode}.referenceTable.relatedApp.app String El identificador de aplicación de la aplicación de origen de datos.
properties.{fieldcode}.referenceTable.relatedApp.code String El código de la aplicación de origen de datos.
Si no se establece ningún código de aplicación de la aplicación, se devolverá una cadena vacía.
properties.{fieldcode}.referenceTable.condition Object Un objeto que contiene datos de la configuración Criterios de captura.
properties.{fieldcode}.referenceTable.condition.field String El código de campo del campo seleccionado para Campo en esta aplicación.
properties.{fieldcode}.referenceTable.condition.relatedField String El código de campo del campo seleccionado para Campo en la aplicación de origen de datos.
properties.{fieldcode}.referenceTable.filterCond String La configuración Filtro, en un formato de consulta.
Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
properties.{fieldcode}.referenceTable.displayFields Array Una lista de códigos de campo de los campos especificados en la configuración Campos de la aplicación de origen de datos para mostrar.
properties.{fieldcode}.referenceTable.sort String La configuración Orden de visualización, en formato de consulta.
Para obtener más datos sobre los formatos de consulta, consulte el siguiente artículo:
Cadena de consulta
properties.{fieldcode}.referenceTable.size String La configuración Número máximo de registros que se mostrarán a la vez.
properties.{fieldcode}.lookup Object Objeto que contiene la configuración del campo Búsqueda.
null se devuelve si no hay permisos de visualización para la aplicación de origen de datos.
properties.{fieldcode}.lookup.relatedApp Object Un objeto que contiene datos de la configuración Aplicación de origen de datos.
properties.{fieldcode}.lookup.relatedApp.app String El identificador de aplicación de la aplicación de origen de datos.
properties.{fieldcode}.lookup.relatedApp.code String El código de la aplicación de origen de datos.
Se devuelve una cadena vacía si no se establece ningún código de aplicación.
properties.{fieldcode}.lookup.relatedKeyField String El código de campo para el campo establecido en la configuración Campo clave.
properties.{fieldcode}.lookup.fieldMappings Array Una lista de conjuntos de datos para la configuración Asignaciones de campos.
Si no se establece nada, se devolverá una cadena vacía.
properties.{fieldcode}.lookup.fieldMappings[].field String El código de campo del campo establecido para el punto de conexión de asignación.
properties.{fieldcode}.lookup.fieldMappings[].relatedField String El código de campo del campo establecido para el origen de asignación.
properties.{fieldcode}.lookup.lookupPickerFields Array Una lista de códigos de campo de campos establecidos para la configuración Campos mostrados en el selector de búsqueda.
Si no se establece nada, se devolverá una cadena vacía.
properties.{fieldcode}.lookup.filterCond String La consulta de filtro predeterminada para la configuración Filtro.
Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
properties.{fieldcode}.lookup.sort String El criterio de clasificación predeterminado para la configuración Filtro.
Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
properties.{fieldcode}.openGroup String La opción Mostrar campos de este grupo.
  • true: El campo Grupo se muestra abierto de forma predeterminada.
  • false: El campo Grupo se muestra cerrado de forma predeterminada.
properties.{fieldcode}.fields Object Objeto que contiene datos de campos de una tabla.
Los parámetros de este objeto son los mismos que los de la función properties parámetro.
properties.{fieldcode}.enabled String La configuración de activación/desactivación de las entidades.
Solo se devuelve para el estado y las categorías de gestión de procesos.
  • En Campos de estado:
    • true: La función Gestión de procesos está habilitada.
    • false: La función Gestión de procesos está desactivada.
  • En Campos de categoría:
    • true: La función Categoría está habilitada
    • false: La función Categoría está deshabilitada
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
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
57
{
  "properties": {
    "Text__single_line_1": {
      "type": "SINGLE_LINE_TEXT",
      "code": "Text__single_line_1",
      "label": "Text (single-line)",
      "noLabel": false,
      "required": true,
      "unique": true,
      "maxLength": "64",
      "minLength": "0",
      "defaultValue": "",
      "expression": "",
      "hideExpression": false
    },
    "Number": {
      "type": "NUMBER",
      "code": "Number",
      "label": "Number",
      "noLabel": true,
      "required": false,
      "unique": false,
      "maxValue": "64",
      "minValue": "0",
      "defaultValue": "12345",
      "expression": "",
      "digit": true,
      "displayScale": "",
      "unit": "$",
      "unitPosition": "BEFORE"
    },
    "Radio_Button": {
      "type": "RADIO_BUTTON",
      "code": "Radio_Button",
      "defaultValue": "sample2",
      "label": "Radio Button",
      "noLabel": false,
      "required": true,
      "options": {
        "sample1": {
          "label": "sample1",
          "index": 0
        },
        "sample2": {
          "label": "sample2",
          "index": 1
        },
        "sample3": {
          "label": "sample3",
          "index": 2
        }
      },
      "align": "horizontal"
    }
  },
  "revision": "2"
}