Obtener campos de formulario
Obtiene la lista de campos y la configuración de campos de una aplicación.
Método | GET |
---|---|
URL | https://{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-Type | application/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 | Sí | El identificador de la aplicación. |
lang | Cuerda | El idioma localizado en el que se recuperarán los datos:
|
*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 un encabezado Accept-Language, se utilizará el idioma establecido en la configuración de "Localización" en el menú del administrador del sistema.
Solicitud de muestra
|
|
XMLHttpRequest
|
|
Parámetros de respuesta
Parámetro | Tipo | Descripción |
---|---|---|
properties | Objeto | Un objeto con datos de la configuración del campo. |
properties.{fieldcode}.label | Cuerda | El nombre del campo. |
properties.{fieldcode}.code | Cuerda | El código de campo. |
properties.{fieldcode}.type | Cuerda | El tipo de campo.
|
properties.{fieldcode}.noLabel | Booleano | La opción "Ocultar nombre de campo".
|
properties.{fieldcode}.required | Cuerda | La opción "Campo obligatorio".
|
properties.{fieldcode}.unique | Cuerda | La opción "Prohibir valores duplicados".
|
properties.{fieldcode}.maxValue | Cuerda | El número máximo de caracteres para el campo. |
properties.{fieldcode}.minValue | Cuerda | El número mínimo de caracteres para el campo. |
properties.{fieldcode}.maxLength | Cuerda | El número máximo de dígitos para el campo. |
properties.{fieldcode}.minLength | Cuerda | El número mínimo de dígitos para el campo. |
properties.{fieldcode}.defaultValue | Cadena o matriz | El valor predeterminado. Se devolverá una matriz para los campos que pueden establecer varios valores predeterminados. |
properties.{fieldcode}.defaultNowValue | Cuerda | 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}.label | Cuerda | El nombre de la opción. |
properties.{fieldcode}.options.{optionname}.index | Cuerda | El orden de visualización (ascendente) de la opción, cuando aparece con las otras opciones. |
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 | Cuerda | La configuración de "Ocultar fórmula" para el campo.
|
properties.{fieldcode}.digit | Cuerda | La opción "Usar separadores de miles".
|
properties.{fieldcode}.thumbnailSize | Cuerda | El tamaño de la miniatura de la imagen en píxeles. |
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 | Cuerda | 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 | Arreglo | Una matriz que enumera los usuarios preestablecidos para el campo. |
properties.{fieldcode}.entities[].code | Cuerda | El código del usuario/grupo/departamento. |
properties.{fieldcode}.entities[].type | Cuerda | El tipo de entidad.
|
properties.{fieldcode}.referenceTable | Objeto | 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 | Objeto | Un objeto que contiene datos de la configuración "Aplicación de origen de datos". |
properties.{fieldcode}.referenceTable.relatedApp.app | Cuerda | El identificador de aplicación de la aplicación de origen de datos. |
properties.{fieldcode}.referenceTable.relatedApp.code | Cuerda | 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 | 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 | Arreglo | 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 artículo: Cadena de consulta |
properties.{fieldcode}.referenceTable.size | Cuerda | La configuración "Número máximo de registros que se mostrarán a la vez". |
properties.{fieldcode}.lookup | Objeto | 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 | Objeto | Un objeto que contiene datos de la configuración "Aplicación de origen de datos". |
properties.{fieldcode}.lookup.relatedApp.app | Cuerda | El identificador de aplicación de la aplicación de origen de datos. |
properties.{fieldcode}.lookup.relatedApp.code | Cuerda | 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 | Cuerda | El código de campo para el campo establecido en la configuración "Campo clave". |
properties.{fieldcode}.lookup.fieldMappings | Arreglo | 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 | Cuerda | El código de campo del campo establecido para el punto de conexión de asignación. |
properties.{fieldcode}.lookup.fieldMappings[].relatedField | Cuerda | El código de campo del campo establecido para el origen de asignación. |
properties.{fieldcode}.lookup.lookupPickerFields | Arreglo | 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 | 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 | Cuerda | 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 de la función Propiedades parámetro. |
properties.{fieldcode}.enabled | Cuerda | 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.
|
revision | Cuerda | El número de revisión de la configuración de la aplicación. |
Ejemplo de respuesta
|
|