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

目次

information

このページで説明しているAPIは、2024年5月版で正式リリースされました。
アプリ管理者用メモを取得する

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

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

利用するには開発中の新機能の「アプリ管理者用メモを取得または変更する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"
}