Actualizar campos de formulario

Actualiza la configuración de campo de los campos en forma de 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/fields.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/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

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 Entero o cadena El identificador de la aplicación.
properties Objeto Un objeto con datos de la configuración del campo.
properties.{fieldcode} Objeto Un objeto con datos de la configuración de campo del campo especificado en {fieldcode}.
Para actualizar un código de campo, indique el código de campo actual en **{fieldcode}**e indique el nuevo código de campo en properties. {fieldcode}.code.
properties.{fieldcode}.label Cuerda El nombre del campo.
properties.{fieldcode}.code Cuerda El código de campo del campo.
Los códigos de campo tienen las siguientes limitaciones:- El límite máximo de caracteres es de 128
  • No pueden existir códigos de campo duplicados
  • _ es el único símbolo que se puede utilizar
  • Los números no se pueden usar para iniciar un código de campo
properties.{fieldcode}.type Cuerda El tipo de campo.
  • GROUP: Grupo
  • GROUP_SELECT: Selección de grupos
  • CALC: Calculado
  • 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
  • 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: Mensaje de texto
  • 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: SOLTERO_LINK_TEXT o NUMBER, en función del tipo de campo Clave que esté buscando.
properties.{fieldcode}.noLabel Booleano o cadena La opción "Ocultar nombre de campo".
  • true: El nombre del campo se ocultará.
  • false: Se mostrará el nombre del campo.
properties.{fieldcode}.required Booleano o cadena La opción "Campo obligatorio".
  • true: El campo será un campo obligatorio.
  • false: El campo no será obligatorio.
properties.{fieldcode}.unique Booleano o cadena La opción "Prohibir valores duplicados".
  • true: Se prohibirán los valores duplicados.
  • false: No se prohibirán los valores duplicados.
properties.{fieldcode}.maxValue Entero o cadena El número máximo de caracteres para el campo.
properties.{fieldcode}.minValue Entero o cadena El número mínimo de caracteres para el campo.
properties.{fieldcode}.maxLength Entero o cadena El número máximo de dígitos para el campo.
properties.{fieldcode}.minLength Entero o cadena El número mínimo de dígitos para el campo.
properties.{fieldcode}.defaultValue Cadena o matriz El valor predeterminado.
En el caso de los campos que pueden establecer varios valores predeterminados, especifique el valor como una matriz.
El defaultNowValue tendrá prioridad si también se especifica.
En el caso de los campos Usuario/Grupo/Departamento, una matriz de objetos que incluye code y type son obligatorios.
  • properties.{fieldcode}.defaultValue[].codeState
    el código del Usuario/Grupo/Departamento, o la función "LOGINUSER()". No se pueden especificar departamentos para aplicaciones en espacios de invitado.
  • properties.{fieldcode}.defaultValue[].typeState
    El tipo del valor predeterminado
    • USER: Usuario
    • GROUP: Grupo
    • ORGANIZATION: Departamento
    • FUNCTION: Función
properties.{fieldcode}.defaultNowValue Booleano o cadena La opción "Por defecto a la fecha de creación del registro".
  • true: La fecha de creación del registro se utilizará como valor predeterminado.
  • false: La fecha de creación del registro no se utilizará como valor predeterminado.
properties.{fieldcode}.options Objeto Un objeto que incluye datos de las opciones del campo.
properties.{fieldcode}.options.{optionname} Objeto Un objeto con datos de la configuración de las opciones.
Especifique los nombres de opción actuales para este parámetro. Las opciones que no estén especificadas se eliminarán.
Si se especifica una nueva opción para este parámetro, se tratará como una nueva opción.
properties.{fieldcode}.options.{optionname}.label Cuerda El nombre para mostrar de la opción.
Si se especifica una nueva opción para properties. {fieldcode}.options. {optionname}, especifique el mismo valor para este parámetro.
properties.{fieldcode}.options.{optionname}.index Entero o cadena Condicional El orden de visualización (ascendente) de la opción, cuando aparece con las otras opciones.
Obligatorio, si se establece el parámetro properties. {fieldcode}.options parámetro.
properties.{fieldcode}.align Cuerda El diseño de las opciones.
  • HORIZONTAL: Las opciones se enumerarán horizontalmente.
  • VERTICAL: Las opciones se enumerarán verticalmente.
properties.{fieldcode}.expression Cuerda Expresión de fórmula utilizada en el campo.
properties.{fieldcode}.hideExpression Booleano o cadena La configuración de "Ocultar fórmula" para el campo.
  • true: La fórmula estará oculta.
  • false: Se mostrará la fórmula.
properties.{fieldcode}.digit Booleano o cadena La opción "Usar separadores de miles".
  • true: Se mostrarán separadores de miles para el número.
  • false: Los separadores de miles no se mostrarán para el número.
properties.{fieldcode}.thumbnailSize Entero o cadena El tamaño de la miniatura de la imagen en píxeles.
Especifique una de las siguientes opciones: 50, 150, 250, 500
properties.{fieldcode}.protocol Cuerda 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 Cuerda 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 Entero o cadena El número de decimales que se mostrarán para el campo.
properties.{fieldcode}.unit Cuerda La configuración de moneda del campo.
properties.{fieldcode}.unitPosition Cuerda La posición de visualización de la moneda.
  • BEFORE: La moneda se mostrará antes del valor del campo.
  • AFTER: La moneda se mostrará después del valor del campo.
properties.{fieldcode}.entities Matriz de objetos Una matriz que enumera los usuarios preestablecidos para el campo.
properties.{fieldcode}.entities[].code Cuerda Condicional El código del usuario/grupo/departamento.
Obligatorio, si el entities se especifica el parámetro.
properties.{fieldcode}.entities[].type Cuerda Condicional El tipo de entidad.
  • USER: Usuario
  • GROUP: Grupo
  • ORGANIZATION: Departamento
Obligatorio, si el entities se especifica el parámetro.
properties.{fieldcode}.referenceTable Objeto Objeto que contiene la configuración del campo Registros relacionados.
properties.{fieldcode}.referenceTable.relatedApp Objeto Un objeto que contiene datos de la configuración "Aplicación de origen de datos".
Si se especifica este parámetro, todas las configuraciones de este campo Registros relacionados, excepto la configuración "Aplicación de origen de datos", volverán a la configuración predeterminada.
properties.{fieldcode}.referenceTable.relatedApp.app Entero o cadena Condicional El identificador de aplicación de la aplicación de origen de datos. Si el relatedApp se especifica, ya sea este parámetro o properties. {fieldcode}.referenceTable.relatedApp.code será necesario.
Si se establecen ambos parámetros, properties. {fieldcode}.referenceTable.relatedApp.code tendrá prioridad.
properties.{fieldcode}.referenceTable.relatedApp.code Cuerda Condicional El código de la aplicación de origen de datos.
Si el relatedApp se especifica, ya sea este parámetro o properties. {fieldcode}.referenceTable.relatedApp.app será necesario.
Si se establecen ambos parámetros, properties. {fieldcode}.referenceTable.relatedApp.code tendrá prioridad.
properties.{fieldcode}.referenceTable.condition Objeto Un objeto que contiene datos de la configuración "Criterios de captura".
properties.{fieldcode}.referenceTable.condition.field Cuerda El código de campo del campo seleccionado para "Campo en esta aplicación".
properties.{fieldcode}.referenceTable.condition.relatedField Cuerda El código de campo del campo seleccionado para "Campo en la aplicación de origen de datos".
properties.{fieldcode}.referenceTable.filterCond Cuerda 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 Matriz de cadenas 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 Cuerda La configuración "Orden de visualización", en formato de consulta.
Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
properties.{fieldcode}.referenceTable.size Entero o cadena La configuración "Número máximo de registros que se mostrarán a la vez".
Especifique una de las siguientes opciones: 1, 3, 5, 10, 20, 30, 40, 50
properties.{fieldcode}.lookup Objeto Objeto que contiene la configuración del campo Búsqueda.
properties.{fieldcode}.lookup.fieldMappings Matriz de objetos Una lista de conjuntos de datos para la configuración "Asignaciones de campos".
properties.{fieldcode}.lookup.fieldMappings[].field Cuerda Condicional El código de campo del campo establecido para el punto de conexión de asignación. Obligatorio, si se establece el parámetro lookup parámetro.
properties.{fieldcode}.lookup.fieldMappings[].relatedField Cuerda Condicional El código de campo del campo establecido para el origen de asignación.
Obligatorio, si se establece el parámetro lookup parámetro.
properties.{fieldcode}.lookup.lookupPickerFields Matriz de cadenas Una lista de códigos de campo de campos establecidos para la configuración "Campos mostrados en el selector de búsqueda".
properties.{fieldcode}.lookup.filterCond Cuerda 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 Cuerda 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 Booleano o cadena La opción "Mostrar campos de este grupo".
  • true: El campo Grupo se mostrará abierto de forma predeterminada.
  • false: El campo Grupo se mostrará cerrado de forma predeterminada.
properties.{fieldcode}.fields Objeto Objeto que contiene datos de campos de una tabla.
Los parámetros de este objeto son los mismos que los del parámetro properties.
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.

Solicitudes 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
var body = {
  'app': kintone.app.getId(),
  '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',
      'digit': true,
      'displayScale': '',
      'expression': '',
      'unit': '$',
      'unitPosition': 'BEFORE'
    }
  }
};

kintone.api(kintone.api.url('/k/v1/preview/app/form/fields.json', true), 'PUT', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});
 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
var body = {
  'app': kintone.app.getId(),
  'properties': {
    'Table': {
      'type': 'SUBTABLE',
      'fields': {
        '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',
          'digit': true,
          'displayScale': '',
          'expression': '',
          'unit': '$',
          'unitPosition': 'BEFORE'
        }
      }
    }
  }
};

kintone.api(kintone.api.url('/k/v1/preview/app/form/fields.json', true), 'PUT', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});
 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
// Update labels "APRICOT", "Banana", "Coconut" to  "Apricot", "Banana", "Coconut", "Dragon Fruit"
var body = {
  'app': kintone.app.getId(),
  'properties': {
    'drop_down_field_code': {
      'type': 'DROP_DOWN',
      'code': 'dropdown',
      'label': 'dropdown',
      'noLabel': false,
      'required': false,
      'options': {
        'APRICOT': {
          'label': 'Apricot',
          'index': '1'
        },
        'Banana': {
          'label': 'Banana',
          'index': '2'
        },
        'Coconut': {
          'label': 'Coconut',
          'index': '3'
        },
        'Dragon Fruit': {
          'label': 'Dragon Fruit',
          'index': '4'
        }
      },
      'defaultValue': '',
    },
  }
};

kintone.api(kintone.api.url('/k/v1/preview/app/form/fields.json', true), 'PUT', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

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": "1"
}

Limitaciones

Los códigos de campo de los siguientes campos no se pueden actualizar

  • Etiqueta
  • Espacio en blanco
  • Frontera
  • Status
  • Cesionario
  • Categoría