Documentos de API

Obtener registro

Recupera los detalles de 1 registro de una aplicación especificando el identificador de aplicación y el identificador de registro.

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/record.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/record.json
Autenticación Autenticación de contraseña, Autenticación de token de API, Autenticación de sesión
Content-Typeapplication/json (no es necesario si se especifica la consulta con una cadena de consulta)

Contenido

Parámetros de solicitud

PARÁMETRO VALOR OBLIGATORIO DESCRIPCIÓN
app Entero o cadena Sí El identificador de la aplicación.
id Entero o cadena Sí El ID de registro.

Solicitudes de ejemplo (cadena de consulta)

Cadena de consulta 

1

https://{subdomain}.kintone.com/k/v1/record.json?app=20&id=100

JavaScript using kintone.api() 

1
2
3
4
5
6
7

kintone.api(kintone.api.url('/k/v1/record.json', true) + '?app=20&id=100', 'GET', {}, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

Muestra de curl 

1
2

curl -X GET 'https://{subdomain}.kintone.com/k/v1/record.json?app=20&id=100' \
  -H 'X-Cybozu-API-Token: {APIToken}'

Solicitudes de ejemplo (JSON)

JavaScript using kintone.api() with JSON 

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

var body = {
  'app': 20,
  'id': 100
};

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

Muestra de curl 

1
2
3
4

curl -X GET 'https://{subdomain}.kintone.com/k/v1/record.json' \
  -H 'X-Cybozu-API-Token: {APIToken}' \
  -H 'Content-Type: application/json' \
  -d '{"app": 20, "id": 100}'

Parámetros de respuesta

Parámetro Tipo Descripción
record Objeto El tipo y el valor de todos los campos del registro se incluyen en el objeto.

Ejemplo de respuesta

Se responde a un objeto de registro de los campos que existen en la aplicación especificada. La información de cada campo incluye el tipo de campo y los valores almacenados en el registro especificado de la aplicación.

Para obtener más información sobre los tipos de campo, consulte el siguiente artículo:
Tipos de campo

 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
41
42
43
44
45
46

{
  "record": {
    "Updated_datetime": {
      "type": "UPDATED_TIME",
      "value": "2019-03-11T04:50:00Z"
    },
    "Created_datetime": {
      "type": "CREATED_TIME",
      "value": "2019-03-11T04:50:00Z"
    },
    "Number": {
      "type": "NUMBER",
      "value": "1"
    },
    "Record_number": {
      "type": "RECORD_NUMBER",
      "value": "1"
    },
    "Text": {
      "type": "SINGLE_LINE_TEXT",
      "value": "sample"
    },
    "Created_by": {
      "type": "CREATOR",
      "value": {
        "code": "Administrator",
        "name": "Administrator"
      }
    },
    "$revision": {
      "type": "__REVISION__",
      "value": "1"
    },
    "Updated_by": {
      "type": "MODIFIER",
      "value": {
        "code": "Administrator",
        "name": "Administrator"
      }
    },
    "$id": {
      "type": "__ID__",
      "value": "1"
    }
  }
}

Obtener varios registros

Para recuperar datos de varios registros, consulte el siguiente artículo:
Obtener registros

Notas

  • El idioma de los datos de registro devueltos depende del método de autenticación utilizado:
    • Cuando el Accept-Language request header, se devolverá el idioma especificado, si se ha establecido en la configuración regional. Para obtener más información sobre los encabezados de solicitud, consulte el siguiente documento:
      Encabezados de solicitud
    • Autenticación de token de API: Se utilizará el idioma de visualización de la cuenta de administrador.
    • Otras formas de autenticación: Se utilizará el idioma de visualización de la cuenta de usuario.
    • Cuando el idioma de visualización se establece en Usar la configuración del navegador web, el idioma especificado en el Administración de Usuarios y Sistemas Se usará la configuración regional.
    • La configuración regional del sistema se puede cambiar a través de la función Administración de Usuarios y Sistemas Configuración regional. Para obtener más información, consulte el siguiente artículo:
      Configuración del idioma del sistema (External link)