kintone API ドキュメント

アプリ管理者用メモを変更する

目次

caution
警告

このページで説明しているAPIは、開発を検討中のAPIです。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。
設定方法は、 新機能の有効／無効の切り替え手順 (External link) を参照してください。

APIに関するフィードバックを、ユースケースとともに、 kintone の改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • APIラボで提供されているAPIを早く本番環境で利用したい
  • こういう用途で使うために、このようなAPIを提供してほしい

アプリ管理者用メモを変更する

固定リンクがコピーされました

アプリ管理者用メモとその設定を変更します。

利用するには開発中の新機能の「アプリ管理者用メモを取得または変更するREST API」を有効にしてください。

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 文字列 省略可 アプリ管理者用メモ
0文字以上、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 文字列 アプリの設定を変更したあとのリビジョン番号です。