Obtener formulario
Recupera los detalles del formulario de una aplicación.
Atención
Esta ruta de URL de API solo admite la recuperación de datos de formularios.
Para las API que tienen funcionalidades similares que también admiten métodos de actualización relacionados, consulte las siguientes API:
Obtener la API de campos de formulario
Obtener API de diseño de formulario
Además, la herramienta Kintone Config Helper también se puede utilizar para recuperar información de campo de las aplicaciones. Para obtener más información, consulte el siguiente artículo:
Kintone Config Helper
Obtener formulario
Recupera los detalles del formulario de una aplicación.
Esto incluye detalles como los nombres de los campos, la configuración de los campos, los valores predeterminados, etc.
Método | GET |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/form.json |
URL (espacio de invitado) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/form.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 necesita permiso para ver registros o agregar registros.
Parámetros de solicitud
Parámetro | Valor | Obligatorio | Descripción |
---|---|---|---|
app | Entero o cadena | Sí | El identificador de la aplicación. |
Solicitud de muestra
Solicitud de ejemplo mediante cadenas de consulta
Envíe el parámetro "app" como una cadena de consulta HTTP.
Cadena de consulta
|
|
Encabezado de solicitud
|
|
Solicitud de ejemplo mediante JSON
Encabezado de solicitud
|
|
Cuerpo
|
|
Parámetros de respuesta
NOMBRE DE LA PROPIEDAD | key | VALORES | SAMPLE |
---|---|---|---|
Nombr | label | Cadena (no estará vacía) | "label": "title" |
Código de campo | code | Cadena (no estará vacía) | "code": "field code" |
ID de elemento | elementId | Cadena (no estará vacía) | "elementId": "Espacio" |
Tipo de campo | type | El TIPO que aparece en la tabla "Propiedades recuperadas por cada campo" a continuación. | "type": "CHECK_BOX" |
Ocultar el nombre del campo | noLabel | "true" o "false" | "noLabel": "true" |
Campo requerido | required | "true" o "false" | "required": "true" |
Prohibir valores duplicados | unique | "true" o "false" | "unique": "true" |
Límites de valor | maxValue | Entero o nulo | "maxValue": "1" |
minValue | Entero o nulo | "minValue": "100" |
|
Número de caracteres | maxLength | Entero o nulo | "maxLength": "5" |
minLength | Entero o nulo | "minLength": "2" |
|
Valor predeterminado | defaultValue | Cadena o Cadena vacía o nula | "defaultValue": "este es el valor predeterminado" Si se pueden establecer varios valores predeterminados, se devolverá una matriz con esos valores |
Valor predeterminado (relacionado con el tiempo) | defaultExpression | "NOW" o nulo | "defaultExpression": "NOW" Si la opción "Predeterminado a la fecha de creación del registro" está activada, "NOW" serán devueltos. En este caso, defaultValue será NULL. |
Opciones (para campos con selecciones) | options | Matriz de cadenas (no será una cadena vacía) | "options": ["A","B","C"] |
Fórmula | expression | Cadena o "" | "expression": "price * amount" Las fórmulas se escriben con códigos de campo. |
Usar separadores de miles | digit | "true" o "false" | "digit": "true" |
Tipo(Enlace) | protocol |
|
"protocol": "WEB" |
Mostrar como | format |
|
"Formato": "NUMBER" |
Número de decimales | displayScale | El número de decimales o nulos | "displayScale": "4" |
Ocultar fórmula | hideExpression | "true" o "false" | "hideExpression": "false" |
Id. de aplicación de origen de datos (para búsqueda, registros relacionados) | relatedApp | Entero o nulo (nulo si no tiene permiso para administrar la aplicación de origen de datos) |
"relatedApp": "123" |
Campos dentro de tablas | fields | Arreglo | "fields": [ |
Divisa | unit | Cadena o null (si no se establece) | "unit": "$" |
Prefix/Suffix | unitPosition | "BEFORE" (Prefijo) "AFTER" (Sufijo) El valor predeterminado se establece en "Before". |
"unitPosition": "BEFORE" |
Propiedades recuperadas por cada campo
TIPO DE CAMPO | TIPO | PROPIEDADES QUE SE RECUPERAN |
---|---|---|
Etiqueta | LABEL |
|
Texto de una sola línea | SINGLE_LINE_TEXT o NUMBER (Depende de la configuración del Búsqueda campo) |
|
Número | NUMBER |
|
Calculado | CALC |
|
Texto de varias líneas | MULTI_LINE_TEXT |
|
Texto enriquecido | RICH_TEXT |
|
Casilla de verificación | CHECK_BOX |
|
Botón de opción | RADIO_BUTTON |
|
Menú desplegable | DROP_DOWN |
|
Opción múltiple | MULTI_SELECT |
|
Archivo adjunto | FILE |
|
Fecha | DATE |
|
Hora | TIME |
|
Fecha y hora | DATETIME |
|
Enlace | LINK |
|
Espacio en blanco | SPACER |
|
Frontera | HR |
|
Selección de usuarios | USER_SELECT |
|
Selección de departamentos | ORGANIZATION_SELECT |
|
Selección de grupo | GROUP_SELECT |
|
Búsqueda | SINGLE_LINE_TEXT |
|
Registros relacionados | REFERENCE_TABLE |
|
Número de registro | RECORD_NUMBER |
|
Creado por | CREADOR |
|
Fecha y hora creada | CREATED_TIME |
|
Actualizado por | MODIFIER |
|
Fecha y hora actualizada | UPDATED_TIME |
|
Mesa | SUBTABLE |
|
Campos que no se pueden recuperar
- Categorías
- Status
- Grupo de Campo
- Los siguientes campos si están dentro de un grupo de campos:
- Campos generados automáticamente (Número de registro, Creado por, Fecha y hora creada, Actualizado por, Fecha y hora actualizada), Espacio en blanco, Etiqueta, Borde
Ejemplo de respuesta
Las propiedades de campo de cada campo de las aplicaciones se devuelven como datos JSON.
|
|
JavaScript Samples
|
|
Ejemplo de XMLHttpRequest
|
|
Ajustes previos a la transmisión en vivo
Recupera los detalles del formulario de una aplicación que aún está experimentando cambios y los cambios no se han aplicado.
URL | https://{subdomain}.kintone.com/k/v1/preview/form.json |
---|---|
URL (espacio de invitado) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/form.json |
Los parámetros de solicitud y las propiedades de respuesta son los mismos que los de la API Get Form.
JavaScript Samples
Solicitud de API REST de Kintone Ejemplo
|
|
Ejemplo de XMLHttpRequest
|
|
Nota
Este documento indicaba erróneamente que esta API iba a quedar obsoleta en el futuro.
Todavía no hay ningún plan para dejar de usar esta API. Pedimos disculpas por los inconvenientes que esto pueda haber causado a nuestros desarrolladores de Kintone.