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 | String | 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 ningún encabezado Accept-Language, el idioma establecido en el Localización en el menú del administrador del sistema.
Solicitud de muestra
|
|
XMLHttpRequest
|
|
Parámetros de respuesta
Parámetro | Tipo | Descripción |
---|---|---|
properties | Object | Un objeto con datos de la configuración del campo. |
properties.{fieldcode}.label | String | El nombre del campo. |
properties.{fieldcode}.code | String | El código de campo. |
properties.{fieldcode}.type | String | El tipo de campo.
|
properties.{fieldcode}.noLabel | Boolean | La opción Ocultar nombre de campo.
|
properties.{fieldcode}.required | String | La opción Campo obligatorio.
|
properties.{fieldcode}.unique | String | La opción Prohibir valores duplicados.
|
properties.{fieldcode}.maxValue | String | El número máximo de caracteres para el campo. |
properties.{fieldcode}.minValue | String | El número mínimo de caracteres para el campo. |
properties.{fieldcode}.maxLength | String | El número máximo de dígitos para el campo. |
properties.{fieldcode}.minLength | String | El número mínimo de dígitos para el campo. |
properties.{fieldcode}.defaultValue | String o Array | El valor predeterminado. Se devolverá una matriz para los campos que pueden establecer varios valores predeterminados. |
properties.{fieldcode}.defaultNowValue | String | La opción Por defecto a la fecha de creación del registro.
|
properties.{fieldcode}.options | Object | Un objeto que incluye datos de las opciones del campo. |
properties.{fieldcode}.options.{optionname}.label | String | El nombre de la opción. |
properties.{fieldcode}.options.{optionname}.index | String | El orden de visualización (ascendente) de la opción, cuando aparece con las otras opciones. |
properties.{fieldcode}.align | String | El diseño de las opciones.
|
properties.{fieldcode}.expression | String | Expresión de fórmula utilizada en el campo. |
properties.{fieldcode}.hideExpression | String | La configuración de Ocultar fórmula para el campo.
|
properties.{fieldcode}.digit | String | La opción Usar separadores de miles.
|
properties.{fieldcode}.thumbnailSize | String | El tamaño de la miniatura de la imagen en píxeles. |
properties.{fieldcode}.protocol | String | La configuración del tipo de vínculo para el campo.
|
properties.{fieldcode}.format | String | El formato de visualización de los campos con cálculos:
|
properties.{fieldcode}.displayScale | String | El número de decimales que se mostrarán para el campo. |
properties.{fieldcode}.unit | String | La configuración de moneda del campo. |
properties.{fieldcode}.unitPosition | String | La posición de visualización de la moneda.
|
properties.{fieldcode}.entities | Array | Una matriz que enumera los usuarios preestablecidos para el campo. |
properties.{fieldcode}.entities[].code | String | El código del usuario/grupo/departamento. |
properties.{fieldcode}.entities[].type | String | El tipo de entidad.
|
properties.{fieldcode}.referenceTable | Object | 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 | Object | Un objeto que contiene datos de la configuración Aplicación de origen de datos. |
properties.{fieldcode}.referenceTable.relatedApp.app | String | El identificador de aplicación de la aplicación de origen de datos. |
properties.{fieldcode}.referenceTable.relatedApp.code | String | 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 | Object | Un objeto que contiene datos de la configuración Criterios de captura. |
properties.{fieldcode}.referenceTable.condition.field | String | El código de campo del campo seleccionado para Campo en esta aplicación. |
properties.{fieldcode}.referenceTable.condition.relatedField | String | El código de campo del campo seleccionado para Campo en la aplicación de origen de datos. |
properties.{fieldcode}.referenceTable.filterCond | String | 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 | Array | 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 | String | 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 | String | La configuración Número máximo de registros que se mostrarán a la vez. |
properties.{fieldcode}.lookup | Object | 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 | Object | Un objeto que contiene datos de la configuración Aplicación de origen de datos. |
properties.{fieldcode}.lookup.relatedApp.app | String | El identificador de aplicación de la aplicación de origen de datos. |
properties.{fieldcode}.lookup.relatedApp.code | String | 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 | String | El código de campo para el campo establecido en la configuración Campo clave. |
properties.{fieldcode}.lookup.fieldMappings | Array | 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 | String | El código de campo del campo establecido para el punto de conexión de asignación. |
properties.{fieldcode}.lookup.fieldMappings[].relatedField | String | El código de campo del campo establecido para el origen de asignación. |
properties.{fieldcode}.lookup.lookupPickerFields | Array | 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 | String | 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 | String | 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 | String | La opción Mostrar campos de este grupo.
|
properties.{fieldcode}.fields | Object | Objeto que contiene datos de campos de una tabla. Los parámetros de este objeto son los mismos que los de la función properties parámetro. |
properties.{fieldcode}.enabled | String | 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 | String | El número de revisión de la configuración de la aplicación. |
Ejemplo de respuesta
|
|