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

連結已複製

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

HTTP 方法	PUT
URL	https://sample.cybozu.com/k/v1/preview/app/adminNotes.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/adminNotes.json
認證	密碼驗證 , API令牌認證 , 會話認證
Content-Type	application/json

請求參數

連結已複製

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

回應屬性

連結已複製

屬性名稱	類型	說明
revision	字串	變更應用設置后的修訂號。

所需存取權限

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求標頭

1
2
3
4


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

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

請求主體

1
2
3
4
5
6


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

範例回應

1
2
3


{
    "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);

使用curl傳送請求

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

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文件

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

目錄

請求參數

回應屬性

所需存取權限

範例