kintone API文件

獲取已新增到應用的外掛程式清單

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

選取已新增到應用的外掛程式清單

連結已複製

選取已新增到應用的外掛程式清單

URL

連結已複製

獲取生產環境的設置時，URL 與獲取測試環境的設置時不同。

如果要獲取正式環境的設置
常規應用程式
https://sample.cybozu.com/k/v1/app/plugins.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/ゲストスペースID/v1/app/plugins.json
獲取操作測試環境的設置
常規應用程式
https://sample.cybozu.com/k/v1/preview/app/plugins.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/ゲストスペースID/v1/preview/app/plugins.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

  • 應用程式管理權限

請求

連結已複製

參數
參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
lang 字串 可省略 選取的外掛程式名稱的區域設置
kintone外掛程式開發步驟｜可指定的區域設置
  • ja：日文
  • en：英語
  • zh：中文
  • es： 西班牙文
如果省略，將應用執行 API 的使用者設置為顯示語言的語言。
如果語言設置為「與網路瀏覽器設定相同」，則要獲取的語言取決於是否存在「Accept-Language」標頭。
  • 帶標題：帶標頭：「Accept-Language」標頭中指定的語言
  • 無標頭：在cybozu.com通用管理的地區設定中設置的語言
    地區設定 (External link)
示例請求
標頭
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

有關請求頭的更多資訊，請參閱以下頁面。
kintone REST API通用規範

正文
1
2
3
4

{
  "app": 1,
  "lang": "ja"
}

回應

連結已複製

屬性
屬性名稱 類型 說明
plugins 陣列（物件） 獲取已新增到應用的外掛程式清單
plugins[].id 字串 新增外掛程式
plugins[].name 字串 外掛程式的名稱
plugins[].enabled 布爾值 外掛程式是否啟用
  • true：啟用
  • false：停用
revision 字串 應用設置的修訂號
應答範例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
    "plugins": [
        {
            "id": "djmhffjhfgmebgnmcggopedaofckljlj",
            "name": "外掛程式名稱",
            "enabled": true
        }
    ],
    "revision": "2"
}

示例代碼

連結已複製

使用 curl 的請求
1
2
3
4
5
6
7

curl -X GET 'https://sample.cybozu.com/k/v1/app/plugins.json' \
  -H 'X-Cybozu-API-Token: "API_TOKEN"' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "lang": "ja"
  }'
kintone.api()請求使用

有關詳細的kintone.api()，請參閱以下頁面。
發送kintone REST API請求API 

1
2
3
4
5

const body = {
  app: 1,
  lang: 'ja'
};
await kintone.api(kintone.api.url('/k/v1/app/plugins.json', true), 'GET', body);