kintone 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
リクエストの例
ヘッダー
1
2
3
4

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

リクエストヘッダーの詳細は次のページを参照してください。
kintone REST APIの共通仕様

ボディ
1
2
3

{
  "app": 1
}

レスポンス

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

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

{
  "content": "<div>アプリの管理者用メモ</div>",
  "includeInTemplateAndDuplicates": true,
  "revision": "2"
}

サンプルコード

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

curlを使ったリクエスト
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()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信するAPI 

1
2
3
4

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