Obtener esquema de API

Documentos de API

Obtener esquema de API

Recupera la información del esquema de la API de una API de Kintone.
La información del esquema de las siguientes APIs no puede ser recuperada:

Obtener la lista de API
Obtén API Schema (esta API)

Método	GET
URL	https://{subdomain}.kintone.com/k/v1/apis/{API_ID}.json
Autenticación	No es necesario
Content-Type

Permisos

Ninguno

Parámetros de camino

Parámetro	Descripción
API_ID	El ID de la API para recuperar la información del esquema para. Este ID es el nombre clave de la `apis` objeto de la API Get API List (Get API List). Obtener la lista de API Por ejemplo, para la API Get Record (`/k/v1/record.json` [GET]), el nombre clave es `record/get`, y la ruta de la URL sería `https://{subdomain}.kintone.com/k/v1/apis/record/get.json`.

Parámetros de solicitud

Ninguno

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

Cuando se desactivan las funciones de Espacio, Personas y Espacio de Invitados, la información de esquema de esas APIs aún puede recuperarse.

Parámetro	Tipo	Descripción
id	Cuerda	El ID de la API. Esto puede obtenerse de la `apis.(key)` respondió desde la API Get API List List.
baseUrl	Cuerda	La URL base que comienza con "https://" que se usará con la API.
path	String	La ruta de la API, como `records.json`. El `baseURL` + `path` 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	Object	La información de esquema común en todas las API. El nombre de la propiedad representa la cadena de información del Esquema, que se referencia en el `$ref` llave.

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
68
69
70
71
72
73
74
75
76
77
78


{
  "id": "records/get",
  "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"
      },
      "totalCount": {
        "format": "boolean",
        "type": "string"
      }
    }
  },
  "response": {
    "type": "object",
    "properties": {
      "records": {
        "type": "array",
        "items": {
          "type": "object",
          "patternProperties": {
            "*": {
              "anyOf": [
                { "$ref": "CalcSimpleValue" },
                { "$ref": "CategorySimpleValue" }
                // ...
              ],
              "type": "object"
            }
          }
        }
      },
      "totalCount": {
        "format": "long",
        "type": "string"
      }
    }
  },
  "schemas": {
    "SingleLineTextSimpleValue": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": ["CATEGORY", "CREATED_TIME"]
        },
        "value": { "type": "string" }
      }
    },
    "MultipleLineTextSimpleValue": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": ["CATEGORY", "CREATED_TIME"]
        },
        "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.

type	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.

En el futuro podrían añadirse más formatos Kintone personalizados.

Acerca de las API de archivos

API de subida de archivos (PUBLICACIÓN `/k/v1/apis/json`)

El objeto de solicitud en el Esquema JSON contiene formatos Kintone personalizados, pero la solicitud API deberá enviarse como un formato Multipart/form-data.

Descargar API de archivos (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.

Documentos de API