獲取kintone REST API的Schema資訊
本頁面使用機器翻譯而成。
機器翻譯免責聲明
獲取kintone REST API的Schema資訊
獲取指定kintone REST API的Schema資訊。
架構資訊不適用於以下 API:
- 用於獲取kintone REST API清單的API
- kintone REST API(此API)的Schema資訊檢索方法
URL
https://sample.cybozu.com/k/v1/apis/API_ID
.json
路徑參數
參數名稱 | 說明 |
---|---|
API 的 ID | 要檢索其架構資訊的 API 的 ID ID為 取得kintone REST API清單 的金鑰名稱。 apis 例如, 對於檢索單個記錄的 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 架構表示。 |
response | 物件 | API 回應架構資訊 它以 JSON 架構表示。 |
schemas | 物件 | API 中常用的 Schema 資訊清單 屬性名稱是表示架構資訊的字串。 在 JSON 架構中用 $ref 引用它。 |
示例回應
|
|
關於 JSON 架構
上述請求、回應和架構中使用的 JSON 架構基於草稿 v4。
它使用核心和驗證,而不是超架構。
- core definitions and terminology draft-zyp-json-schema-04
- interactive and non interactive validation draft-fge-json-schema-validation-00
類型和格式
除了JSON Schema中定義的格式外,還定義了以下格式來表示kintone的參數限制。
Kintone將來可能會添加自己的格式。
type | format | 說明 |
---|---|---|
string | long | -9,223,372,036,854,775,808 ~ 9,223,372,036,854,775,807 範圍內的整數類型 |
string | locale | ""、"en"、"ja"或"zh"的字符串 |
string | boolean | "true"或"false"字符串 |
string | 電子郵件格式字串 | |
string | number | 實實型 |
string | query | kintone查詢表示法 關於查詢表示法 ,請參考kintone API查詢編寫基礎 。 |
string | date-time | ISO 格式的日期和時間字串 |
string | timezone | 指示時區的字串 |
檢索檔 API 的架構
檔上傳 API
JSON模式請求物件包含kintone內部類型資訊。
實際請求應以 multipart/form-data 格式發送。
檔下載 API
JSON 架構回應物件返回空。
實際請求下載檔。
示例代碼
使用 curl 的請求
|
|
發送kintone REST API請求 使用API 發送請求
|
|