Obtener esquema de API
Obtiene la información del esquema de API de una API de Kintone.
Método | GET |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/apis/*.json |
Autenticación | Ninguno |
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
|
|
XMLHttpRequest
|
|
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
|
|
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.
-
core definitions and terminology draft-zyp-json-schema-04
-
Validación interactiva y no interactiva draft-fge-json-schema-validation-00
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. |
*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.