Documentos de API

Tipos de campo

Contenido

Para empezar

Los campos y sus Códigos de campo, Tiposy 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.

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 especifica que el código de la aplicación sea "APPCODE", el número de registro tendrá 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.

Respuestas sobre el terreno

CAMPO TIPO EJEMPLO DE RESPUESTA
(Reemplácelo <field_code> con el código de campo de su campo)
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
Mensaje de texto SINGLE_LINE_TEXT 
"<field_code>": {
  "type": "SINGLE_LINE_TEXT",
  "value": "Hello Kintone"
}
Número NUMBER 
"<field_code>": {
  "type": "NUMBER",
  "value": "777"
}
Calculado CALC 
"<field_code>": {
  "type": "CALC",
  "value": "777888999"
}
El "valor" variará dependiendo de la opción "Mostrar como" establecida en la configuración del campo
  • Número: "777888999"
  • Número con separador de miles: "777888999"
  • Fecha y hora: "1994-08-26T08:16:39Z"
  • Fecha: "1994-08-26"
  • Hora: "08:16"
  • Horas y minutos: "216080:16"
  • Días y horas y minutos: "216080:16"
El valor de "value" son cadenas vacías para los siguientes eventos:
Á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>"
}
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"
}
Menú desplegable DROP_DOWN 
"<field_code>": {
  "type": "DROP_DOWN",
  "value": "Opción 1"
}
Opción múltiple MULTI_SELECT 
"<field_code>": {
  "type": "MULTI_SELECT",
  "value": [
    "Choice 1",
    "Choice 2"
  ]
}
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.
Enlace LINK 
"<field_code>": {
  "type": "LINK",
  "value": "https://www.kintone.com/"
}
Fecha DATE 
"<field_code>": {
  "type": "DATE",
  "value": "2015-04-15"
}
Hora TIME 
"<field_code>": {
  "type": "TIME",
  "value": "09:00"
}
Fecha y hora DATETIME 
"<field_code>": {
  "type": "DATETIME",
  "value": "2015-03-17T10:20:00Z"
}
Referencia: Formatos de fecha
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"
    }
  ]
}
Categorías CATEGORY 
"Categories": {
  "type": "CATEGORY",
  "value": [
    "category1",
    "category2"
  ]
}
Estado STATUS 
"Status": {
  "type": "STATUS",
  "value": "Not started"
}
Cesionario STATUS_ASSIGNEE 
"Assignee": {
  "type": "STATUS_ASSIGNEE",
  "value": [
    {
      "code": "john-d",
      "name": "John Doe"
    }
  ]
}
Búsqueda SINGLE_LINE_TEXT o NUMBER
*Esto depende del tipo de campo del campo clave.		 Si los campos clave son un SINGLE_LINE_TEXT
"<field_code>": {
  "type": "SINGLE_LINE_TEXT",
  "value": "Código003"
}
Si los campos clave son un NÚMERO
"<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"
          ]
        }
      }
    }
  ]
}

Solicitudes de campo

CAMPO TIPO SOLICITUD DE MUESTRA
(Reemplácelo <field_code> con el código de campo de su campo)
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 
"<field_code>": {
  "value": {
    "code": "john-d"
  }
}
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 
"<field_code>": {
  "value": {
    {
      "code": "john-d"
    }
  }
}
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
Mensaje de texto SINGLE_LINE_TEXT 
"<field_code>": {
  "value": "Esto es Kintone"
}
Número NUMBER 
"<field_code>": {
  "value": "111"
}
Calculado CALC Los valores de este campo no se pueden crear ni actualizar.
Á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>\"
}
Casilla de verificación * CHECK_BOX 
"<field_code>": {Check box
  "value": [
    "Choice1",
    "Choice2"
  ]
}
Botón de opción * RADIO_BUTTON 
"<field_code>": {
  "value": "Choice3"
}
Menú desplegable * DROP_DOWN 
"<field_code>": {
  "value": "Choice3"
}
Opción múltiple * MULTI_SELECT 
"<field_code>": {
  "value": [
    "Choice1",
    "Choice2"
  ]
}
Archivo adjunto FILE 
"<field_code>": {
  "type": "FILE",
  "valor": [
    {
      "fileKey":"20150417022053715283FF97DC413CBC4B7A41C",
    },
    {
      "fileKey": "20150417022159ECFC1223C4B34C939E1B9BD25",
    }
  ]
}
Enlace LINK 
"<field_code>": {
  "value": "https://www.kintone.com/"
}
Fecha DATE 
"<field_code>": {
  "value": "2015-04-15"
}
Hora TIME 
"<field_code>": {
  "value": "09:00"
}
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
Selección de usuarios USER_SELECT 
"<field_code>": {
  "value": [
    {
      "code": "john-d"
    },
    {
      "code": "jane-r"
    }
  ]
}
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"
    }
  ]
}
Categorías CATEGORY Los valores de este campo no se pueden crear ni actualizar.
Estado STATUS Los valores de este campo no se pueden crear ni actualizar.
Cesionario STATUS_ASSIGNEE Los valores de este campo no se pueden crear ni actualizar.
Búsqueda SINGLE_LINE_TEXT o NUMBER
*Esto depende del tipo de campo del campo clave.		 
"<field_code>": {
  "value": "Código001"
}
La creación/actualización de campos de búsqueda no se puede iniciar con tokens de API. La opción "Prohibir valores duplicados" debe estar marcada para el campo clave de la aplicación de origen de datos.
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"
        }
      }
    }
  ]
}
  • Cuando desee actualizar las tablas o agregar más datos, la API eliminará primero todas las filas de la tabla y, a continuación, agregará el número de filas que haya indicado en los datos JSON. Esto significa que, si ya tiene 3 filas de datos de tabla y solo especifica 1 fila en su JSON, su tabla final se generará como 1 fila de datos y no 4.
  • Si especifica el "id" de una fila en su JSON, puede actualizar esa fila específica.
  • La API de JavaScript funciona de manera diferente: si está utilizando la API de JavaScript para agregar filas, deberá especificar el tipo de campo en su JSON.
  • Al agregar o eliminar un objeto de fila a/desde el parámetro de la tabla, s_value_ se pueden agregar o eliminar filas de la tabla
    e.g.
    • Agregue una fila: record['table']['value'].push(row);
    • Eliminar una fila: record['table']['value'].pop();

*Para los valores, especifique las opciones que configuró en la configuración del campo (las opciones eliminadas aún se pueden especificar a través de API o CSV)

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 VALOR VACÍO RESPONDIDO
  • Mensaje de texto
  • Área de texto
  • Menú desplegable
  • Enlace
  • Fecha y hora
  • Búsqueda
  • Texto de Rixh
 
{ "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