Documentos de API

Tipos de campo

Contenido

Campos y sus códigos, tipos y valores

Los campos siguen el formato JSON que se muestra en las tablas de las secciones siguientes:

Cada campo de una aplicación Kintone tiene un Código de campo, que es único dentro de la aplicación. Estos códigos de campo son necesarios al crear, recuperar y actualizar datos a través de la API. Para verificar o cambiar el código de campo, coloque el cursor sobre el campo en la configuración de la aplicación y abra el menú de configuración desde la rueda dentada que aparece.

Los códigos de campo de los siguientes campos no se pueden cambiar: en este caso, especifique el nombre de estos campos cuando utilice la API de Kintone.

  • Categorías
  • Estado
  • Cesionario

Kintone tiene varios campos que se pueden colocar dentro de la aplicación: el tipo Especifica a qué tipo de campo pertenece el destino. El tipo se devolverá al recuperar datos de Kintone, pero no será necesario al crear o actualizar datos.
* Hay una excepción al crear/actualizar tablas utilizando la API de JavaScript, donde en algunos casos será necesario especificar el TYPE.
El valor especifica el valor que el campo contiene, o mantendrá, en función de la API utilizada.
Para obtener más información, consulte el siguiente documento:
Descripción general de los códigos de campo (External link)

El número de registro y el ID de registro

Estos dos campos suenan parecidos, pero asegúrate de entender la diferencia antes de continuar. Sin embargo, si no se modifica la configuración del código de la aplicación, estos dos campos tienen los mismos valores.

  • Número de registro
    Un número de registro es un número que se asigna automáticamente a cada registro de una aplicación.
    El número es único dentro de la aplicación, lo que significa que no hay dos registros en la aplicación que puedan tener el mismo número de registro.
    Sin embargo, el formato del número de registro se puede modificar a través de la configuración avanzada de la aplicación, especificando un código de aplicación. Si el código de aplicación se establece en "APPCODE", el número de registro se mostrará en el siguiente formato de ejemplo: "APPCODE-1".
  • ID de registro
    El ID de registro, al igual que el número de registro, es un número que se asigna automáticamente a cada registro de una aplicación. El ID de registro siempre será un número.
    Utilice el ID de registro cuando utilice las API de Kintone.

Campos para el formato de formulario

Los siguientes son campos para personalizar formularios. No es posible obtener/agregar/actualizar valores.

  • Etiqueta
  • Espacio en blanco
  • Frontera
  • Grupo de Campo

Utilice las siguientes API para obtener o modificar la configuración de los formularios:

No es posible obtener/agregar/actualizar valores del campo Registros relacionados.

Utilice las siguientes API para obtener o modificar la configuración de los formularios:

Campos numéricos

Cuando se utiliza la API de JavaScript de Kintone, los valores que se pueden recuperar o modificar en los campos numéricos son los siguientes:

  • Números
    • + o - Se puede utilizar para expresar valores positivos y negativos.
    • . se puede utilizar para expresar decimales.
    • e o E se puede utilizar para expresar exponenciales.
  • Espacios en blanco

Al utilizar kintone.app.record.set() o un objeto de evento para actualizar el valor, se pueden utilizar los siguientes valores:

  • undefined, null: El valor de la variable Número se vaciará.
  • #INVALID!: El valor de la variable Número no se cambiará.

Si se introduce un valor no válido en el campo Número, se devolverá #INVALID!.

Para obtener más información sobre kintone.app.record.set(), consulte el siguiente artículo:
Establecer valor de registro

Respuestas sobre el terreno

Reemplazar <field_code> con el código de campo apropiado.

Campos relacionados con la información de registro

CAMPO TIPO EJEMPLO DE RESPUESTA
Número de registro RECORD_NUMBER Si no se establece un código de aplicación (valor predeterminado):
"<field_code>": {
  "type": "RECORD_NUMBER",
  "value": "7"
}
Si se establece un código de aplicación:
"<field_code>": {
  "type": "RECORD_NUMBER",
  "value": "APPCODE-7"
}
ID de registro __ID__ 
"$id": {
  "type": "__ID__",
  "value": "3"
}
Revisión __REVISION__ 
"$revision": {
  "type": "__REVISIÓN__",
  "value": "9"
}
Creado por CREATOR Para usuarios de Kintone:
"<field_code>": {
  "type": "CREATOR",
  "value": {
    "code": "john-d",
    "name": "John Doe"
  }
}
Para usuarios invitados:
"<field_code>": {
  "type": "CREATOR",
  "value": {
    "code": "guest/ab@kintone.com",
    "name": "Alfred Bills"
  }
}
Fecha y hora creada CREATED_TIME 
"<field_code>": {
  "type": "CREATED_TIME",
  "value": "2015-01-22T15:07:00Z"
}
Referencia: Formatos de fecha
Actualizado por MODIFIER Para usuarios de Kintone:
"<field_code>": {
  "type": "MODIFIER",
  "value": {
    "code": "john-d",
    "name": "John Doe"
  }
}
Para usuarios invitados:
"<field_code>": {
  "type": "MODIFIER",
  "value": {
    "code": "guest/ab@kintone.com",
    "name": "Alfred Bills"
  }
}
Fecha y hora actualizada UPDATED_TIME 
"<field_code>": {
  "type": "UPDATED_TIME",
  "value": "2015-01-22T15:07:00Z"
}
Referencia: Formatos de fecha

Campos personalizados

CAMPO TIPO EJEMPLO DE RESPUESTA
Mensaje de texto SINGLE_LINE_TEXT 
"<field_code>": {
  "type": "SINGLE_LINE_TEXT",
  "value": "Hello Kintone"
}
Área de texto MULTI_LINE_TEXT 
"<field_code>": {
  "type": "MULTI_LINE_TEXT",
  "value": "Hello\nKintone"
}
Texto enriquecido RICH_TEXT 
"<field_code>": {
  "type": "RICH_TEXT",
  "value": "<a href=\"https://www.kintone.com\">Kintone</a>"
}
Número NUMBER 
"<field_code>": {
  "type": "NUMBER",
  "value": "777"
}
Referencia: [ Número Campos](#number-fields)
Calculado CALC 
"<field_code>": {
  "type": "CALC",
  "value": "777888999"
}
El value variará en función de la opción Show as establecida en la configuración del campo.
  • Número: 777888999
  • Número con separador de miles: 777888999
  • date-time: 2024-08-26T08:16:39Z
  • Fecha: 2024-08-26
  • Hora : 08:16
  • Horas y minutos: 49:30 (49 horas 30 minutos)
  • Días y horas y minutos: 49:30 (2 días 1 hora 30 minutos)
El valor de value son cadenas vacías para los siguientes eventos:
Casilla de verificación CHECK_BOX 
"<field_code>": {
  "type": "CHECK_BOX",
  "value": [
    "Choice 1",
    "Choice 2"
  ]
}
Botón de opción RADIO_BUTTON 
"<field_code>": {
  "type": "RADIO_BUTTON",
  "value": "Opción 3"
}
Opción múltiple MULTI_SELECT 
"<field_code>": {
  "type": "MULTI_SELECT",
  "value": [
    "Choice 1",
    "Choice 2"
  ]
}
Menú desplegable DROP_DOWN 
"<field_code>": {
  "type": "DROP_DOWN",
  "value": "Opción 1"
}
Selección de usuarios USER_SELECT Para usuarios de Kintone:
"<field_code>": {
  "type": "USER_SELECT",
  "value": [
    {
      "code": "john-d",
      "name": "John Doe"
    },
    {
      "code": "jane-r",
      "name": "Jane Roe"
    }
  ]
}
Para usuarios invitados:
"<field_code>": {
  "type": "USER_SELECT",
  "value": [
    {
      "code": "guest/ab@kintone.com",
      "name": "Alfred Bills"
    },
    {
      "code": "guest/cd@kintone.com",
      "name": "Cal Davis"
    }
  ]
}
Selección de departamentos ORGANIZATION_SELECT 
"<field_code>": {
  "type": "ORGANIZATION_SELECT",
  "value": [
    {
      "code": "human_resources",
      "name": "Human Resources"
    },
    {
      "code": "sales",
      "name": "Ventas"
    }
  ]
}
Selección de grupo GROUP_SELECT 
"<field_code>": {
  "type": "GROUP_SELECT",
  "value": [
    {
      "code": "project_manager",
      "name": "Project Manager"
    },
    {
      "code": "team_leader",
      "name": "Team Leader"
    }
  ]
}
Fecha DATE 
"<field_code>": {
  "type": "DATE",
  "value": "2015-04-15"
}
Referencia: Formatos de fecha
Hora TIME 
"<field_code>": {
  "type": "TIME",
  "value": "09:00"
}
Referencia: Formatos de fecha
Fecha y hora DATETIME 
"<field_code>": {
  "type": "DATETIME",
  "value": "2015-03-17T10:20:00Z"
}
Referencia: Formatos de fecha
Enlace LINK 
"<field_code>": {
  "type": "LINK",
  "value": "https://www.kintone.com/"
}
Archivo adjunto FILE 
"<field_code>": {
  "type": "FILE",
  "value": [
    {
      "contentType": "text/plain",
      "fileKey":"20150417022053715283FF97DC413CBC4B7A41C",
      "name": "kintoneUpdates.txt",
      "size": "25302"
    },
    {
      "contentType": "text/plain",
      "fileKey": "20150417022159ECFC1223C4B34C939E1B9BD25",
      "name": "APIUpdatestxt",
      "size": "20311"
    }
 ]
}
El fileKey incluido en la respuesta solo se puede usar para descargar archivos.
Búsqueda SINGLE_LINE_TEXT o NUMBER
*Esto depende del tipo de campo del campo clave.		 Si los campos clave son SINGLE_LINE_TEXT
"<field_code>": {
  "type": "SINGLE_LINE_TEXT",
  "value": "Código003"
}
Si los campos clave son NUMBER
"<field_code>": {
  "type": "NUMBER",
  "value": "10"
}
Mesa SUBTABLE 
"<field_code>": {
  "type": "SUBTABLE",
  "value": [
    {
      "id": "48277",
      "value": {
        "textfield_0": {
          "type": "SINGLE_LINE_TEXT",
          "value": "Hello Kintone 1"
        },
        "numberfield_0": {
          "type": "NUMBER",
          "value": "5"
        },
        "checkboxfield_0": {
          "type": "CHECK_BOX",
          "value": [
            "Choice1"
          ]
        }
      }
    },
    {
      "id": "48278",
      "value": {
        "textfield_0": {
          "type": "SINGLE_LINE_TEXT",
          "value": "Hello Kintone 2"
        },
        "numberfield_0": {
          "type": "NUMBER",
          "value": "7"
        },
        "checkboxfield_0": {
          "type": "CHECK_BOX",
          "value": [
            "Choice2"
          ]
        }
      }
    }
  ]
}
Registros relacionados REFERENCE_TABLE Los valores de este campo no se pueden actualizar.
Categorías CATEGORY 
"Categories": {
  "type": "CATEGORY",
  "value": [
    "category1",
    "category2"
  ]
}
Estado de la gestión de procesos STATUS 
"Status": {
  "type": "STATUS",
  "value": "Not started"
}
Persona asignada del status de Gestión de Procesos STATUS_ASSIGNEE 
"Assignee": {
  "type": "STATUS_ASSIGNEE",
  "value": [
    {
      "code": "john-d",
      "name": "John Doe"
    }
  ]
}
Etiqueta LABEL Los valores de este campo no se pueden actualizar.
Espacio en blanco SPACER Los valores de este campo no se pueden actualizar.
Frontera HR Los valores de este campo no se pueden actualizar.
Grupo de Campo GRUPO Los valores de este campo no se pueden actualizar.

Solicitudes de campo

Reemplazar <field_code> con el código de campo apropiado.

Campo relacionado con la información de registro

CAMPO TIPO SOLICITUD DE MUESTRA
Número de registro RECORD_NUMBER Los valores de este campo no se pueden crear ni actualizar.
ID de registro __ID__ Los valores de este campo no se pueden crear ni actualizar.
Revisión __REVISION__ Los valores de este campo no se pueden crear ni actualizar.
Creado por CREATOR Para usuarios de Kintone:
"<field_code>": {
  "value": {
    "code": "john-d"
  }
}
Para usuarios invitados:
"<field_code>": {
  "value": {
    "code": "guest/ab@kintone.com"
  }
}
Los valores de este campo no se pueden actualizar.
Fecha y hora creada CREATED_TIME 
"<field_code>": {
  "value": "2015-01-22T23:07:00Z"
}
o
"<field_code>": {
  "value": "2015-01-22T15:07:00-08:00"
}
Los valores de este campo no se pueden actualizar.
No se pueden establecer fechas y horas futuras.
Referencia: Formatos de fecha
Actualizado por MODIFIER Para usuarios de Kintone:
"<field_code>": {
  "value": {
    "code": "john-d"
  }
}
Para usuarios invitados:
"<field_code>": {
  "value": {
    "code": "guest/ab@kintone.com"
  }
}
Los valores de este campo no se pueden actualizar.
Fecha y hora actualizada UPDATED_TIME 
"<field_code>": {
 "value": "2015-01-22T15:07:00Z"
}
o
"<field_code>": {
  "value": "2015-01-22T15:07:00-08:00"
}
Los valores de este campo no se pueden actualizar.
No se pueden establecer fechas y horas futuras.
Referencia: Formatos de fecha

Campos personalizados

CAMPO TIPO SOLICITUD DE MUESTRA
Mensaje de texto SINGLE_LINE_TEXT 
"<field_code>": {
  "value": "Esto es Kintone"
}
Área de texto MULTI_LINE_TEXT 
"<field_code>": {
  "value": "Esto es\nKintone"
}
Texto enriquecido RICH_TEXT 
"<field_code>": {
  "valor": "<a href=\"https://www.kintone.com">Kintone</a>\"
}
Número NUMBER 
"<field_code>": {
  "value": "111"
}
Referencia: [ Número Campos](#number-fields)
Calculado CALC Los valores de este campo no se pueden crear ni actualizar.
Casilla de verificación * CHECK_BOX 
"<field_code>": {
  "value": [
    "Choice1",
    "Choice2"
  ]
}
Botón de opción * RADIO_BUTTON 
"<field_code>": {
  "value": "Choice3"
}
Si se especifica una cadena vacía, se establece el valor predeterminado.
Opción múltiple * MULTI_SELECT 
"<field_code>": {
  "value": [
    "Choice1",
    "Choice2"
  ]
}
Menú desplegable * DROP_DOWN 
"<field_code>": {
  "value": "Choice3"
}
Selección de usuarios USER_SELECT Para usuarios de Kintone:
"<field_code>": {
  "value": [
   { "code": "john-d" },
   { "code": "jane-r" }
  ]
}
Para usuarios invitados:
"<field_code>": {
  "value": [
    { "code": "guest/ab@kintone.com" },
    { "code": "guest/cd@kintone.com" }
  ]
}
Selección de departamentos ORGANIZATION_SELECT 
"<field_code>": {
  "value": [
    {
      "code": "human_resources"
    },
    {
      "code": "sales"
    }
  ]
}
Selección de grupo GROUP_SELECT 
"<field_code>": {
  "value": [
    {
      "code": "project_manager"
    },
    {
      "code": "team_leader"
    }
  ]
}
Fecha DATE 
"<field_code>": {
  "value": "2015-04-15"
}
Referencia: Formatos de fecha
Hora TIME 
"<field_code>": {
  "value": "09:00"
}
Referencia: Formatos de fecha
Fecha y hora DATETIME 
"<field_code>": {
  "value": "2015-03-17T18:20:00Z"
}
o
"<field_code>": {
  "value": "2015-03-17T10:20:00-08:00"
}
Referencia: Formatos de fecha
Enlace LINK 
"<field_code>": {
  "value": "https://www.kintone.com/"
}
Archivo adjunto FILE 
"<field_code>": {
  "type": "FILE",
  "valor": [
    {
      "fileKey":"20150417022053715283FF97DC413CBC4B7A41C",
    },
    {
      "fileKey": "20150417022159ECFC1223C4B34C939E1B9BD25",
    }
  ]
}
Búsqueda SINGLE_LINE_TEXT o NUMBER
(Esto depende del tipo de campo del campo clave)		 
"<field_code>": {
  "value": "Código001"
}
La opción Prohibir valores duplicados debe estar marcada para el campo clave de la aplicación de origen de datos.
Para usar tokens de API en aplicaciones que contienen campos de búsqueda, consulte el siguiente artículo:
Tokens de API: limitaciones
Mesa SUBTABLE 
"<field_code>": {
  "value": [
    {
      "id": "48277",
      "value": {
        "textfield_0": {
          "value": "Hello Kintone 1"
        },
        "numberfield_0": {
          "value": "5"        }
      }
    },
    {
      "value": {
        "textfield_0": {
          "value": "Hello Kintone 2"
        },
        "numberfield_0": {
          "value": "7"
        }
      }
    },
    {
      "value": {
        "textfield_0": {
          "value": "Hello Kintone 3"
        },
        "numberfield_0": {
          "value": "3"
        }
      }
    }
  ]
}
No agregue un gran número de filas a una sola tabla. Dependiendo de la configuración de la aplicación, la carga afectará al procesamiento de registros, incluida la visualización de registros y las operaciones mediante la API REST.
Para obtener notas sobre cómo trabajar con tablas a través de la API de REST o la API de JavaScript, consulte la siguiente sección:
Notas sobre los tipos de campo de la mesa de operaciones
Registros relacionados REFERENCE_TABLE Los valores de este campo no se pueden crear ni actualizar.
Categorías CATEGORY Los valores de este campo no se pueden crear ni actualizar.
Estado de la gestión de procesos STATUS Los valores de este campo no se pueden crear ni actualizar.
Persona asignada del status de Gestión de Procesos STATUS_ASSIGNEE Los valores de este campo no se pueden crear ni actualizar.
Etiqueta LABEL Los valores de este campo no se pueden crear ni actualizar.
Espacio en blanco SPACER Los valores de este campo no se pueden crear ni actualizar.
Frontera HR Los valores de este campo no se pueden crear ni actualizar.
Grupo de Campo GRUPO Los valores de este campo no se pueden crear ni actualizar.

*Para value, especifique las opciones configuradas en los ajustes del campo (las opciones eliminadas se pueden seguir especificando a través de la API o CSV).

Notas sobre el campo de la mesa de operaciones

Agregar o actualizar a través de la API de JavaScript de Kintone
  • Al agregar o actualizar una tabla, especifique los valores de todas las filas existentes.
  • El orden de las filas es el orden de los datos de la solicitud.
  • El tipo de campo debe especificarse al agregar o actualizar una tabla:
    Sobrescribir valores de campo
Agregar o actualizar a través de la API REST de Kintone
  • Al agregar o actualizar una tabla, especifique los valores de todas las filas existentes.
  • Cuando el id , se actualizará el valor de la fila especificada.
  • El orden de las filas es el orden de los datos de la solicitud.
  • Para reordenar las filas, los datos de la solicitud deben prepararse con el id de las filas.
Adición o eliminación de filas

Las filas se pueden agregar o quitar de una tabla agregando o eliminando objetos de fila en el archivo value parámetro.

Un ejemplo de cómo agregar una fila con push():

1

record['table']['value'].push(row);

Un ejemplo de eliminación de una fila con pop():

1

record['table']['value'].pop();

Respuestas de valor vacío

Los valores vacíos se responden de las siguientes maneras:

TIPO DE CAMPO VALOR VACÍO RESPONDIDO
  • Mensaje de texto
  • Área de texto
  • Número
  • Fecha y hora
  • Enlace
  • Búsqueda
 Al usar las API de JavaScript en la página Agregar registros y en la página Editar registros
{ "value": undefined }
Cuando se usan API de JavaScript en otras páginas o cuando se usan API de REST
{ "value": "" }
  • Texto enriquecido
 Cuando se utiliza la API de JavaScript o las API de REST
{ "value": "" }
  • Fecha
  • Hora
 Al usar las API de JavaScript en la página Agregar registros y en la página Editar registros
{ "value": undefined }
Cuando se usan API de JavaScript en otras páginas o cuando se usan API de REST
{ "value": null }
  • Menú desplegable
 Al usar las API de REST
{ "value": null }
Al usar las API de JavaScript en la página Agregar registros y en la página Editar registros
{ "value": undefined }
Al usar API de JavaScript en otras páginas
{ "value": "" }
  • Botón de opción
 Al usar las API de REST
{ "value": null }
Al usar las API de JavaScript
{ "value": "" }
  • Casilla de verificación
  • Opción múltiple
  • Archivo adjunto
  • Selección de usuarios
  • Selección de departamentos
  • Selección de grupos
  • Categorías
  • Mesa
  • Cesionario
 Al usar API de JavaScript o API de REST
{ "value": [] }

Solicitudes de valor vacías

Los valores vacíos se solicitan de las siguientes maneras:

TIPO DE CAMPO SOLICITUDES DE VALOR VACÍAS
  • Mensaje de texto
  • Área de texto
  • Menú desplegable
  • Enlace
  • Fecha y hora
  • Búsqueda
  • Texto enriquecido
 
{ "value": "" }
o
{ "value": null }
  • Número
 
"value": ""
o
"value": indefinido
o
"value": null
  • Fecha
  • Hora
 
{ "value": null }
  • Casilla de verificación
  • Opción múltiple
  • Archivo adjunto
  • Selección de usuarios
  • Selección de departamentos
  • Selección de grupos
  • Mesa
 
{ "value": [] }
  • Botón de opción
  • Categorías
  • Cesionario
 N/A