kintone 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 文字列 アプリの設定を変更したあとのリビジョン番号です。
レスポンスの例
1
2
3

{
    "revision": "2"
}

サンプルコード

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

curlを使ったリクエスト
1
2
3
4
5
6
7
8
9

curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/adminNotes.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "content": "<div>管理者用メモ</div>",
    "includeInTemplateAndDuplicates": false,
    "revision": 2
  }'
kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信するAPI

1
2
3
4
5
6
7

const body = {
  app: 1,
  content: '<div>管理者用メモ</div>',
  includeInTemplateAndDuplicates: false,
  revision: 2
};
await kintone.api(kintone.api.url('/k/v1/preview/app/adminNotes.json', true), 'PUT', body);