kintone API文件

選取應用程式管理員用備註

information

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

目錄

選取應用程式管理員用備註

連結已複製

獲取有關應用管理員及其設置的註釋。

URL

連結已複製

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

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

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

  • 應用程式管理權限

請求

連結已複製

參數
參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
示例請求
標頭
1
2
3
4

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

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

內文
1
2
3

{
  "app": 1
}

回應

連結已複製

屬性
屬性名稱 類型 說明
content 字串 應用管理員備註的內文
如果未設置，則返回空字串。
includeInTemplateAndDuplicates 布爾值 在應用程式範本或重複利用應用程式時，包含此備註的內容
  • true：包括
  • false：不包括
revision 字串 應用設置的修訂號
應答範例
1
2
3
4
5

{
  "content": "<div>應用管理員注意事項</div>",
  "includeInTemplateAndDuplicates": true,
  "revision": "2"
}

示例代碼

連結已複製

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

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

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

1
2
3
4

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