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

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

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

HTTPメソッド	GET
URL	https://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トークン認証 , セッション認証 , OAuth認証
Content-Type	application/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.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のフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
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
  }'

kintone API

kintone APIドキュメント

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

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル