Obtener formulario

Documentos de API

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

Obtener formulario

Permisos
Parámetros de solicitud
Solicitud de muestra
Parámetros de respuesta
Propiedades recuperadas por cada campo
Ejemplo de respuesta
JavaScript Samples
JavaScript using kintone.api()

Ajustes previos a la transmisión en vivo

JavaScript Samples

Nota

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

1

app=4

Encabezado de solicitud

1
2
3


GET https://example.kintone.com/k/v1/form.json?app=4 HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=

Solicitud de ejemplo mediante JSON

Encabezado de solicitud

1
2
3
4


GET /k/v1/form.json HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=
Content-Type: application/json

Cuerpo

1
2
3


{
  "app": "4"
}

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	"WEB" (URL) "CALL" (Número de teléfono) "MAIL" (Dirección de correo electrónico)	"protocol": "WEB"
Mostrar como	format	"NUMBER" (Número) "NUMBER_DIGIT" (Número con separador de miles) "DATETIME" (Fecha y hora) "DATE" (Fecha) "TIME" (Tiempo) "HOUR_MINUTE" (Horas y minutos) "DAY_HOUR_MINUTE" (Días, horas y minutos)	"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": [ { "code": "singlelinetext_in_table", "defaultValue": "", "expression": "", "hideExpression": "false", "maxLength": "64", "minLength": null, "label": "Full Name", "noLabel": "false", "required": "true", "type": "SINGLE_LINE_TEXT", "unique": "true" }, { "code": "integer_in_table", "defaultValue": "25", "digit": "false", "displayScale": null, "expression": "", "maxValue": null, "minValue": null, "label": "Age", "noLabel": "true", "required": "false", "type": "NUMBER", "unique": "false" } ]
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	Nombr Tipo de campo
Texto de una sola línea	SINGLE_LINE_TEXT o NUMBER (Depende de la configuración del Búsqueda campo)	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Prohibir valores duplicados Número de caracteres Valor predeterminado Fórmula Ocultar fórmula
Número	NUMBER	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Prohibir valores duplicados Límites de valor Valor predeterminado Usar separadores de miles Número de decimales
Calculado	CALC	Nombr Código de campo Tipo de campo Campo obligatorio (siempre falso) Ocultar el nombre del campo Fórmula Mostrar como Número de decimales Ocultar fórmula
Texto de varias líneas	MULTI_LINE_TEXT	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Valor predeterminado
Texto enriquecido	RICH_TEXT	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Valor predeterminado
Casilla de verificación	CHECK_BOX	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Valor predeterminado Opciones
Botón de opción	RADIO_BUTTON	Nombr Código de campo Tipo de campo Campo obligatorio (siempre verdadero) Ocultar el nombre del campo Opciones Valor predeterminado
Menú desplegable	DROP_DOWN	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Opciones Valor predeterminado
Opción múltiple	MULTI_SELECT	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Opciones Valor predeterminado
Archivo adjunto	FILE	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo
Fecha	DATE	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Prohibir valores duplicados Valor predeterminado Valor predeterminado (relacionado con el tiempo)
Hora	TIME	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Valor predeterminado Valor predeterminado (relacionado con el tiempo)
Fecha y hora	DATETIME	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Prohibir valores duplicados Valor predeterminado Valor predeterminado (relacionado con el tiempo)
Enlace	LINK	Nombr Código de campo Tipo de campo Campo requerido Ocultar el nombre del campo Prohibir valores duplicados Tipo(Enlace) Número de caracteres Valor predeterminado
Espacio en blanco	SPACER	ID de elemento Tipo de campo
Frontera	HR	Tipo de campo
Selección de usuarios	USER_SELECT	Nombr Código de campo Campo requerido Tipo de campo Ocultar el nombre del campo
Selección de departamentos	ORGANIZATION_SELECT	Nombr Código de campo Campo requerido Tipo de campo Ocultar el nombre del campo
Selección de grupo	GROUP_SELECT	Nombr Código de campo Campo requerido Tipo de campo Ocultar el nombre del campo
Búsqueda	SINGLE_LINE_TEXT	Nombr Código de campo Campo requerido Ocultar el nombre del campo Id. de aplicación de origen de datos Tipo de campo de Campo clave
Registros relacionados	REFERENCE_TABLE	Nombr Código de campo Tipo de campo Ocultar el nombre del campo Id. de aplicación de origen de datos
Número de registro	RECORD_NUMBER	Nombr Código de campo Tipo de campo Ocultar el nombre del campo
Creado por	CREADOR	Nombr Código de campo Tipo de campo Ocultar el nombre del campo
Fecha y hora creada	CREATED_TIME	Nombr Código de campo Tipo de campo Ocultar el nombre del campo
Actualizado por	MODIFIER	Nombr Código de campo Tipo de campo Ocultar el nombre del campo
Fecha y hora actualizada	UPDATED_TIME	Nombr Código de campo Tipo de campo Ocultar el nombre del campo
Mesa	SUBTABLE	Código de campo Tipo de campo Información de campo dentro de la tabla

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.

 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


{
  "properties": [
    {
      "code": "string_1",
      "defaultValue": "",
      "expression": "",
      "hideExpression": "false",
      "maxLength": "64",
      "minLength": null,
      "label": "string_1",
      "noLabel": "false",
      "required": "true",
      "type": "SINGLE_LINE_TEXT",
      "unique": "true"
    },
    {
      "code": "number_1",
      "defaultValue": "12345",
      "digit": "true",
      "displayScale": "4",
      "expression": "",
      "maxValue": null,
      "minValue": null,
      "label": "number_1",
      "noLabel": "true",
      "required": "false",
      "type": "NUMBER",
      "unique": "false"
    },
    {
      "code": "checkbox_1",
      "defaultValue": ["sample1", "sample3"],
      "label": "checkbox_1",
      "noLabel": "false",
      "options": ["sample1", "sample2", "sample3"],
      "required": "false",
      "type": "CHECK_BOX"
    }
  ]
}

JavaScript Samples

JavaScript using kintone.api()

1
2
3
4
5
6
7
8


kintone.api(kintone.api.url('/k/v1/form.json', true), 'GET', {
  'app': kintone.app.getId()
}, function(resp) {
  console.log(resp);
}, function(error) {
  console.log(error);
}
);

Ejemplo de XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


var apiurl = '/k/v1/form.json?app=' + kintone.app.getId();
var xhr = new XMLHttpRequest();
xhr.open('GET', apiurl, true);
xhr.onload = function() {
  if (xhr.status === 200) {
    console.log(JSON.parse(xhr.responseText));
  } else {
    console.log(xhr.status + ' ' + xhr.statusText);
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.send();

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


var body = {
  'app': 1
};

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

Ejemplo de XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


var params = '?app=1';
var url = 'https://{subdomain}.kintone.com/k/v1/preview/form.json' + params;
console.log(url);
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

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.