Documentos de API

Obtener esquema de API

Obtiene la información del esquema de API de una API de Kintone.

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/apis/*.json
AutenticaciónNinguno
Content-Type

Contenido

Permisos

Ninguno

Parámetros de solicitud

Ninguno, pero reemplace el "*.json" en la URL de la solicitud con el atributo apis. {keys}.link obtenido con la siguiente API:
Obtener la lista de API .
No se pueden usar Get API List y Get Schema API.

Solicitud de muestra

JavaScript using kintone.api() 

1
2
3
4
5
6
7

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

XMLHttpRequest 

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

var url = 'https://{subdomain}.kintone.com/k/v1/apis/record/get.json';
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();

Parámetros de respuesta

Parámetro Tipo Descripción
id Cuerda El ID de la API.
Esto se puede obtener de la apis. (key) respondido desde la API Get API List (Obtener lista de API).
baseUrl Cuerda La URL base que comienza con "https://" que se usará con la API.
path Cuerda La ruta de acceso de la API, como "records.json".
La base URL + ruta se convertirá en la URL de la API.
httpMethod Cuerda El método HTTP para la API
request Objeto La información de esquema para la solicitud de API, en un formato de esquema JSON.
response Objeto La información de esquema para la respuesta de la API, en un formato de esquema JSON.
schemas Objeto La información de esquema común en todas las API.
La clave representa la cadena de la información del esquema.

Ejemplo de respuesta 

 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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

{
  "id": "GetRecords",
  "baseUrl": "https://{subdomain}.kintone.com/k/v1/",
  "path": "records.json",
  "httpMethod": "GET",
  "request": {
    "type": "object",
    "required": ["app"],
    "properties": {
      "app": {
        "type": "string",
        "format": "long"
      },
      "fields": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "query": {
        "type": "string",
        "format": "query"
      }
    }
  },
  "response": {
    "type": "object",
    "properties": {
      "records": {
        "type": "array",
        "items": {
          "type": "object",
          "patternProperties": {
            "*": {
              "$ref": "Field"
            }
          }
        }
      }
    }
  },
  "schemas": {
    "Field": {
      "type": "object",
      "anyOf": [
        { "$ref": "SingleLineText" },
        { "$ref": "MultipleLineText" }
        // ...
      ]
    },
    "SingleLineText": {
      "type": "object",
      "properties": {
        "type": { "enum": ["SINGLE_LINE_TEXT"] },
        "value": { "type": "string" }
      }
    },
    "MultipleLineText": {
      "type": "object",
      "properties": {
        "type": { "enum": ["MULTIPLE_LINE_TEXT"] },
        "value": { "type": "string" }
      }
    }
    // ...
  }
}

Acerca de los esquemas JSON

El esquema JSON anterior utilizado para la solicitud, la respuesta y los esquemas sigue el borrador v4. Se utilizan el núcleo y la validación, pero no se utiliza el esquema Hyper.

Tipo y formato

Para representar los límites utilizados para los parámetros de Kintone, se utilizan los siguientes formatos además de los formatos del esquema JSON.

tipo formato Descripción
cuerda long Un entero dentro del intervalo de -9223372036854775808 a 9223372036854775807.
cuerda locale Cadenas de "", "en", "ja" o "zh".
cuerda booleano Cadenas de "verdadero" o "falso".
cuerda Correo electrónico Cadenas en formato de correo electrónico.
cuerda número Tipo de datos real
cuerda consulta Formato de consulta de Kintone. Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
cuerda date-time Cadena de fecha y hora en formato ISO.
cuerda timezone Cadena que representa la zona horaria.

*Es posible que se agreguen más formatos de Kintone personalizados en el futuro.

Acerca de las API de archivos

API de carga de archivos (POST /k/v1/apis/json)

El objeto de solicitud en el esquema JSON contiene formatos de Kintone personalizados, pero la solicitud de API deberá enviarse como un formato multiparte.

API de archivos de descarga (GET /k/v1/apis/json)

El objeto de respuesta en el esquema JSON está vacío, pero se descargará un archivo cuando se utilice la API.