Actualizar el diseño del formulario

Actualiza la información de diseño de campo de un formulario en 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/form/layout.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/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

Contenido

Permisos

  • Se necesitan permisos de administración de aplicaciones.

Parámetros de solicitud

Los parámetros que se ignoren no se actualizarán
Todos los campos del formulario deben especificarse en la solicitud.

Parámetro Valor Obligatorio Descripción
app Integer El identificador de la aplicació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 Condicional El código de campo del campo Tabla o Grupo. Omitir, si el tipo de fila no es una tabla o un grupo.
layout[].fields Arreglo La lista de campos de 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
  • RADIO_BUTTON: Botón de opción
  • RECORD_NUMBER: Número de registro
  • REFERENCE_TABLE: Registros relacionados
  • RICH_TEXT: Texto enriquecido
  • SINGLE_LINE_TEXT: Mensaje de texto
  • SPACER: Espacio en blanco
  • SUBTABLE: Mesa
  • TIME: Hora
  • UPDATED_TIME: Fecha y hora actualizada
  • USER_SELECT: Selección de usuarios
En Campos de búsqueda, especifique una de las siguientes opciones: SINGLE_LINE_TEXT o NUMBER, en función del tipo de campo Clave que esté buscando.
layout[].fields[].code Cuerda Condicional El código de campo del campo. Ignorar, si el campo es una etiqueta, un espacio en blanco o un borde.
layout[].fields[].label Cuerda El texto que se va a establecer en el campo Etiqueta.
Especifique solo para los campos de etiqueta.
layout[].fields[].elementId Cuerda El ID de elemento que se va a establecer en el campo Espacio en blanco. Especifique solo para los campos de espacio en blanco.
layout[].fields[].size Objeto Un objeto con datos del tamaño del campo.
Dependiendo de cómo se coloque el campo, es posible que el campo no tenga el tamaño especificado.
layout[].fields[].size.width Integer El ancho del campo en píxeles.
El ancho se puede establecer para los siguientes campos:
  • Archivo adjunto
  • Espacio en blanco
  • Frontera
  • Calculado
  • Casilla de verificación
  • Creado por
  • Fecha y hora creada
  • Fecha y hora
  • Fecha
  • Menú desplegable
  • Etiqueta
  • Enlace
  • Búsqueda
  • Opción múltiple
  • Número
  • Botón de opción
  • Número de registro
  • Texto enriquecido
  • Área de texto
  • Mensaje de texto
  • Hora
  • Actualizado por
  • Fecha y hora actualizada
  • Selección de usuarios
layout[].fields[].size.height Integer La altura del campo en píxeles, incluida la altura del nombre del campo.
Solo los campos de espacio en blanco pueden utilizar este parámetro.
layout[].fields[].size.innerHeight Integer La altura del campo en píxeles, excluyendo la altura del nombre del campo.
Solo los siguientes campos pueden utilizar este parámetro:
  • Área de texto
  • Texto enriquecido
layout[].layout Arreglo Una lista de diseños de campo para cada fila dentro de un campo de grupo.
Los parámetros para esto son los mismos para el diseño propiedad.
revision Integer 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
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
70
71
72
73
74
75
76
77
var body = {
  'app': 1,
  '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'
          }
        }
      ]
    }
  ]
};

kintone.api(kintone.api.url('/k/v1/preview/app/form/layout.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
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
var body = {
  'app': 1,
  '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'
          }
        }
      ]
    }
  ],
  // 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/form/layout.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": "4"
}