kintone API

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

獲取要添加外掛程式的應用資訊清單。

目錄

HTTP 方法GET
URLhttps://sample.cybozu.com/k/v1/plugin/apps.json
認證 密碼驗證 , 會話認證
Content-Typeapplication/json

請求參數

參數名稱 類型 必須 說明
id 字串 必須 外掛程式ID
offset 數值或字串 可省略 要從獲取到的清單中跳過的號碼。
如果省略,則設置為0。
limit 數值或字串 可省略 要獲取的應用的最大數量。
您可以指定一個介於 100 和 500 之間的數值。
如果省略,則設置為100。

應答屬性

屬性名稱 類型 說明
apps 陣列(物件) 已添加外掛程式的應用資訊陣列
排序順序按應用程式ID升序。
如果要添加的應用不存在,則返回一個空陣列。
apps[].id 字串 應用ID
apps[].name 字串 應用程式名稱

所需存取權限

  • cybozu.com共通管理員

範例

1
https\://sample.cybozu.com/k/v1/plugin/apps.json?id=djmhffjhfgmebgnmcggopedaofckljlj&offset=1&limit=1
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

1
https\://sample.cybozu.com/k/v1/plugin/apps.json
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

1
2
3
4
5
{
  "id": "djmhffjhfgmebgnmcggopedaofckljlj",
  "offset": 1,
  "limit": 1
}

1
2
3
4
5
6
7
8
{
  "apps": [
    {
      "id": "1",
      "name": "範例應用程式"
    }
  ]
}

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

1
2
3
4
5
6
const body = {
  id: 'djmhffjhfgmebgnmcggopedaofckljlj',
  limit: 1,
};

await kintone.api(kintone.api.url('/k/v1/plugin/apps.json', true), 'GET', body);

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

1
2
3
4
5
6
7
curl -X GET 'https://sample.cybozu.com/k/v1/plugin/apps.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "djmhffjhfgmebgnmcggopedaofckljlj",
    "limit": 1
  }'

補充

  • 您還可以在外掛程式附加項反映之前獲取應用程式資訊。