API スキーマ情報の取得

フォローする

kintone API スキーマ情報の取得

APIのスキーマ情報を個別に取得するためのAPIです。

HTTP メソッド

GET

URI

https://(サブドメイン名).cybozu.com/k/v1/apis/*.json URIは、kintone API一覧の取得 で取得したURLを使用します。

アクセス権

制限はありません。

  • ログイン前ユーザーでも実行可能です。
  • 機能の利用を無効にしている状態でも実行可能です。

リクエストパラメータ

パラメータはありません。

レスポンス

パラメータ名 値の種類 内容
id 文字列 APIを表すIDです。 kintone API 一覧の取得の apis.(key) と同一です。
baseUrl 文字列 各APIを使用する上で基本となるURLです。
path 文字列 APIのパスです。 baseUrl + path が API の URL となります。
httpMethod 文字列 APIを使用するためのHTTPメソッドです。
request オブジェクト APIのリクエストのスキーマ情報です。 JSON Schema で表現されます。
response オブジェクト APIのレスポンスのスキーマ情報です。 JSON Schema で表現されます。
schemas オブジェクト 各API共通で使用するスキーマ情報一覧です。 keyはスキーマ情報を表す文字列です。 JSON Schemaの$refで参照します。
レスポンスの例

JSON Schemaについて

上記のrequest、response、schemasで使用するJSON Schemaは、draft v4を基準とします。 core と validation を使用し、hyper schema は使用しません。

typeとformat

kintoneのパラメータの制限を表現するために、JSON Schemaで定義されている format に加えて、以下のformatを定義します。

type format 説明
string long -9223372036854775808 ~ 9223372036854775807 の範囲の整数型
string locale "", "en", "ja" or "zh" の文字列
string boolean "true" or "false" の文字列
string email Email 形式の文字列
string number 実数型
string query kintoneクエリ記法。 クエリ記法につきましては、こちらを参照して下さい。
string date-time ISO 形式の日時文字列
string timezone タイムゾーンを示す文字列

※ kintone 独自の format につきましては、今後追加される可能性があります。

ファイル API について

ファイルの送信API (/k/v1/apis/json の POST)

JsonSchemaのrequestオブジェクトには、kintoneの内部の型情報が入りますが、 実際のリクエストは、マルチパート形式で送る必要があります。

ファイル取得API (/k/v1/apis/json の GET)

JsonSchemaのresponseオブジェクトは空ですが、 実際にはファイルがダウンロードされます。

JavaScriptサンプル

kintone REST API

XMLHttpRequest

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk