Documentos de API

Obtener diseño de formulario

Obtiene la información de diseño de campo de un formulario en una aplicación.

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

Permisos

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

Parámetros de solicitud

Parámetro Tipo Obligatorio Descripción
app Cuerda Sí El identificador de la aplicación.

Solicitud de muestra

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var body = {
  'app': 1
};

kintone.api(kintone.api.url('/k/v1/app/form/layout.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/layout.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
layout Arreglo Una lista de diseños de campo para cada fila.
layout[].type Cuerda El tipo de fila
  • ROW: Una fila normal de campos.
  • SUBTABLE: Una mesa.
  • GROUP: Un campo de grupo.
layout[].code Cuerda El código de campo del campo Tabla o Grupo. Este parámetro no se devolverá para otros tipos de fila.
layout[].fields Arreglo Una lista de campos en la fila.
layout[].fields[].type Cuerda El tipo de campo.
  • 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
  • HR: Frontera
  • LABEL: Etiqueta
  • LINK: Enlace
  • MODIFIER: Actualizado por
  • MULTI_LINE_TEXT: Área de texto
  • MULTI_SELECT: Opción múltiple
  • NUMBER: Número o Búsqueda*
  • 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*
  • SPACER: Espacio en blanco
  • 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.
layout[].fields[].code Cuerda El código de campo.
layout[].fields[].label Cuerda El texto establecido en el campo Etiqueta.
Solo se devuelve para los campos de etiqueta.
layout[].fields[].elementId Cuerda El ID de elemento del campo Espacio.
Solo se devuelve para los campos espaciales.
layout[].fields[].size Object Un objeto con datos del tamaño del campo solo para PC. El tamaño del campo para dispositivos móviles no puede ser recuperado.
layout[].fields[].size.width Cuerda El ancho del campo en píxeles.
layout[].fields[].size.height Cuerda La altura del campo en píxeles, incluida la altura del nombre del campo.
layout[].fields[].size.innerHeight Cuerda La altura del campo en píxeles, excluyendo la altura del nombre del campo.
layout[].layout Arreglo Una lista de diseños de campo para cada fila dentro de un campo de grupo.
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
58
59
60
61
62
63
64
65
66
67
68
69

{
  "revision": "2",
  "layout": [
    {
      "type": "ROW",
      "fields": [
        {
          "type": "SINGLE_LINE_TEXT",
          "code": "Text__single_line_",
          "size": {
            "width": "200"
          }
        }
      ]
    },
    {
      "type": "SUBTABLE",
      "code": "Table",
      "fields": [
        {
          "type": "SINGLE_LINE_TEXT",
          "code": "Text2__single_line_",
          "size": {
            "width": "193"
          }
        },
        {
          "type": "MULTI_LINE_TEXT",
          "code": "Text_Box__multi_line_",
          "size": {
            "width": "315",
            "innerHeight": "125"
          }
        }
      ]
    },
    {
      "type": "ROW",
      "fields": [
        {
          "type": "NUMBER",
          "code": "Number",
          "size": {
            "width": "193"
          }
        }
      ]
    },
    {
      "type": "ROW",
      "fields": [
        {
          "type": "RECORD_NUMBER",
          "code": "Record_number",
          "size": {
            "width": "141"
          }
        },
        {
          "type": "CREATOR",
          "code": "Created_by",
          "size": {
            "width": "136"
          }
        }
      ]
    }
  ]
}