kintone API

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

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

目錄

HTTP 方法GET
URLhttps://sample.cybozu.com/k/v1/app/adminNotes.json
URL(訪客空間)https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/adminNotes.json
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-Typeapplication/json

請求參數

參數名稱 類型 必須 說明
app 數值或字串 必須 應用程式ID

應答屬性

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

所需存取權限

  • 應用程式管理權限

範例

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

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

1
2
3
{
  "app": 1
}

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

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

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

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

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
  }'