kintone REST API のスキーマ情報を取得する
kintone REST API のスキーマ情報を取得する
指定した kintone REST API のスキーマ情報を取得します。
次の API のスキーマ情報は取得できません。
- kintone REST API の一覧を取得する API
- kintone REST API のスキーマ情報を取得する API(この API)
URL
https://sample.cybozu.com/k/v1/apis/API の ID
.json
パスパラメーター
パラメーター名 | 説明 |
---|---|
API の ID | スキーマ情報を取得する API の ID ID は kintone REST API の一覧を取得する の apis のキー名です。たとえば 1 件のレコードを取得する API の場合、キー名は「record/get」で URL のパスは「https://sample.cybozu.com/k/v1/apis/ record/get .json」です。 |
HTTP メソッド
GET
必要なアクセス権
なし
認証情報は不要です。
リクエスト
パラメーター
なし
リクエストの例
URL
https://sample.cybozu.com/k/v1/apis/record/get.json
ヘッダー
なし
レスポンス
スペース・ピープル・ゲストスペース機能を無効にしている場合でも、それらの API の情報を取得します。
プロパティ名 | 値の種類 | 内容 |
---|---|---|
id | 文字列 | kintone REST API の API の ID |
baseUrl | 文字列 | API を実行するときの基本となる URL |
path | 文字列 | API のパスbaseUrl と path を結合した値が API の URL です。 |
httpMethod | 文字列 | API を実行するための HTTP メソッド |
request | オブジェクト | API リクエストのスキーマ情報 JSON Schema で表現されます。 |
response | オブジェクト | API レスポンスのスキーマ情報 JSON Schema で表現されます。 |
schemas | オブジェクト | API で共通で使用するスキーマ情報一覧 プロパティ名は、スキーマ情報を表す文字列です。 JSON Schemaの $ref で参照します。 |
レスポンスの例
|
|
JSON Schema について
上記の request、response、schemas で使用する JSON Schema は、draft v4 を基準とします。
core と validation を使用し、hyper schema は使用しません。
-
core definitions and terminology draft-zyp-json-schema-04
-
interactive and non interactive validation draft-fge-json-schema-validation-00
type と format
kintone のパラメーターの制限を表現するために、JSON Schema で定義されている format に加えて、次の format を定義しています。
kintone 独自の format は、今後追加される可能性があります。
type | format | 説明 |
---|---|---|
string | long | -9,223,372,036,854,775,808 ~ 9,223,372,036,854,775,807 の範囲の整数型 |
string | locale | "", "en", "ja" or "zh" の文字列 |
string | boolean | "true" or "false" の文字列 |
string | Email 形式の文字列 | |
string | number | 実数型 |
string | query | kintoneクエリ記法 クエリ記法は、 kintone API のクエリの書き方の基本 を参照してください。 |
string | date-time | ISO 形式の日時文字列 |
string | timezone | タイムゾーンを示す文字列 |
ファイル API の Schema 取得
ファイルアップロード API
JSON Schema の request オブジェクトには、kintone の内部の型情報が入ります。
実際のリクエストは、multipart/form-data 形式で送信してください。
ファイルダウンロード API
JSON Schema の response オブジェクトは、空が返ります。
実際のリクエストではファイルがダウンロードされます。
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|