Agregar campos de formulario
Agrega campos a un formulario de 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étodo | POST |
---|---|
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 |
Autenticación | Autenticación de contraseña, Autenticación de token de API, Autenticación de sesión |
Content-Type | application/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 | Sí | El identificador de la aplicación. |
properties | Objeto | Sí | 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 Propiedades. {código de campo}.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:
|
|
properties.{fieldcode}.type | Cuerda | Sí | El tipo de campo.
|
properties.{fieldcode}.noLabel | Booleano o cadena | La opción "Ocultar nombre de campo".
|
|
properties.{fieldcode}.required | Booleano o cadena | La opción "Campo obligatorio".
|
|
properties.{fieldcode}.unique | Booleano o cadena | La opción "Prohibir 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}.defaultNowValue | Booleano o cadena | La opción "Por defecto a la fecha de creación del registro".
|
|
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 Propiedades. {fieldcode}.opciones. {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 Propiedades. {fieldcode}.opciones parámetro. |
properties.{fieldcode}.align | Cuerda | El diseño de las opciones.
|
|
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.
|
|
properties.{fieldcode}.digit | Booleano o cadena | La opción "Usar separadores de miles".
|
|
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.
|
|
properties.{fieldcode}.format | Cuerda | El formato de visualización de los campos con cálculos:
|
|
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.
|
|
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.
|
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 Propiedades. {fieldcode}.referenceTable.relatedApp.code será necesario. Si se establecen ambos parámetros, Propiedades. {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 Propiedades. {código de campo}.referenceTable.relatedApp.app será necesario. Si se establecen ambos parámetros, Propiedades. {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.relatedApp | Objeto | Condicional | Un objeto que contiene la configuración de la aplicación relacionada de la Búsqueda campo. Obligatorio, si se establece el parámetro lookup parámetro. |
properties.{fieldcode}.lookup.relatedApp.app | Entero o cadena | Condicional | El ID de aplicación de la aplicación relacionada de la Búsqueda campo. Este parámetro o el parámetro lookup.relatedApp.code es necesario si se establece el parámetro lookup parámetro. Si se establecen ambos parámetros, el lookup.relatedApp.code tiene prioridad. |
properties.{fieldcode}.lookup.relatedApp.code | Cuerda | Condicional | El código de la aplicación de la aplicación relacionada de la Búsqueda campo. Este parámetro o el parámetro lookup.relatedApp.app es necesario si se establece el parámetro lookup parámetro. Si se establecen ambos parámetros, este parámetro tiene prioridad. |
properties.{fieldcode}.lookup.relatedKeyField | Cuerda | Condicional | El código de campo del campo Búsqueda. Obligatorio, si se establece el parámetro lookup parámetro. |
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".
|
|
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. |
Solicitud de muestra
|
|
XMLHttpRequest
|
|
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
|
|
Limitaciones
No se pueden agregar los códigos de campo de los siguientes campos:
- Etiqueta
- Espacio en blanco
- Frontera
- Estado
- Cesionario
- Categoría