アプリ管理者用メモを取得する

目次

caution
警告

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

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

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

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

アプリ管理者用メモを取得する

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

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

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

レスポンス

プロパティ
プロパティ名 説明
content 文字列 アプリの管理者用メモ本文
未設定の場合、空文字列が返ります。
includeInTemplateAndDuplicates 真偽値 アプリテンプレートやアプリの再利用時にこのメモの内容を含めるかどうか
  • true:含める
  • false:含めない
revision 文字列 アプリの設定のリビジョン番号
レスポンスの例
1
2
3
4
5
{
  "content": "<div>アプリの管理者用メモ</div>",
  "includeInTemplateAndDuplicates": true,
  "revision": "2"
}