kintone API

在測試環境中創建應用

在測試環境中創建應用。

目錄

HTTP 方法POST
網址(測試環境中的一般應用程式)https://sample.cybozu.com/k/v1/preview/app.json
URL(測試環境中的訪客空間應用程式)https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app.json
認證 密碼驗證 , 會話認證 , OAuth認證
Content-Typeapplication/json

請求參數

參數名稱 類型 必須 說明
name 字串 必須 應用的名稱
最多指定 64 個字元。
space 數值 可省略 空間ID
指定是否要在空間主題中創建應用程式。
thread 數值 可省略 主題ID
指定是否要在空間主題中創建應用程式。

回應屬性

屬性名稱 類型 說明
app 字串 已創建的應用的ID
revision 字串 已創建的應用的修訂號

所需存取權限

  • 建立應用程式

範例

1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規格

1
2
3
4
5
{
  "name": "案件管理",
  "space": 10,
  "thread": 11
}

1
2
3
4
{
  "app": "23",
  "revision": "1"
}

有關kintone.api()的說明,請參閱以下頁面。
傳送kintone REST API請求

1
2
3
4
5
6
7
const body = {
  name: '案例管理',
  space: 1001,
  thread: 1001
};

await kintone.api(kintone.api.url('/k/v1/preview/app.json'), 'POST', body);

根據您的環境,curl的格式可能會有所不同。
有關說明,請參閱以下頁面。
使用curl命令執行kintone REST API中的3.執行API (日語)

1
2
3
4
5
6
7
8
curl -X POST 'https://sample.cybozu.com/k/v1/preview/app.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "案件管理",
      "space": 1001,
      "thread": 1001
  }'

補充

  • 測試環境是在部署應用之前臨時存儲有關應用的資訊的位置。
    如果要將變更套用到正式環境,請在執行該API之後,執行將應用設置反映到正式環境的API。
    將應用設置傳播到正式環境API

  • 運行此 API 不計入 API 請求數。

  • 自動創建的下一個字段是運行 API 的使用者設置的顯示語言的名稱。

    • 記錄號碼
    • 建立人
    • 更新人
    • 建立時間
    • 更新時間
    • 狀態
    • 執行者
    • 類別

    如果語言設置為「與網路瀏覽器設定相同」,則要獲取的語言取決於是否存在「Accept-Language」標頭。

    • 帶標題:帶標頭:「Accept-Language」標頭中指定的語言
    • 無標頭:在cybozu.com通用管理的地區設定中設置的語言
      地區設定 (External link)
  • 不能使用 API 權杖。

  • 有關在測試環境中創建應用程式、更改設置並將其反映在正式版應用程式的步驟,請參閱以下頁面。
    創建應用和變更設置的流程