kintone API文件

變更應用程式管理員用備註

information

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

目錄

變更應用程式管理員用備註

連結已複製

變更應用程式管理員註釋及其設置。

URL

連結已複製

常規應用程式
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 方法

連結已複製

PUT

所需存取權限

連結已複製

  • 應用程式管理權限

請求

連結已複製

參數
參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
content 字串 可省略 應用程式管理員用備註
指定 1 到 10,000 個字元。
如果省略，則不會變更。
includeInTemplateAndDuplicates 布爾值或字串 可省略 在應用程式範本或重複利用應用程式時，包含此備註的內容
  • true：包括
  • false：不包括
如果省略，則不會變更。
revision 數值或字串 可省略 預期修訂號
如果與實際修訂號不匹配，則會發生錯誤，並且不會變更設置。
如果指定值「-1」或未指定值，則不會驗證修訂號。
請求範例
標頭
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}
正文
1
2
3
4
5
6

{
  "app": 1,
  "content": "<div>管理員注意事項</div>",
  "includeInTemplateAndDuplicates": false,
  "revision": 2
}

回應

連結已複製

屬性
屬性名稱 類型 說明
revision 字串 變更應用設置后的修訂號。
示例回應
1
2
3

{
    "revision": "2"
}

示例代碼

連結已複製

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

curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/adminNotes.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "content": "<div>管理員注意事項</div>",
    "includeInTemplateAndDuplicates": false,
    "revision": 2
  }'
kintone.api()請求使用

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

1
2
3
4
5
6
7

const body = {
  app: 1,
  content: '<div>管理員注意事項</div>',
  includeInTemplateAndDuplicates: false,
  revision: 2
};
await kintone.api(kintone.api.url('/k/v1/preview/app/adminNotes.json', true), 'PUT', body);