ダッシュボードの詳細の更新

最終更新日: 17 年 2024 月 XNUMX 日

LogicMonitor REST API v3 を使用して、ダッシュボードの詳細を更新できます。 API リクエストを行う前に、自分自身を認証する必要があります。

URI: パッチ /dashboard/dashboards/{id}

URI: PUT /dashboard/dashboards/{id}

注: REST 標準に従って、PUT リクエストで指定されていないプロパティはデフォルト値に戻ります。

タイプ説明
id整数(必須の) 更新するダッシュボードの ID。
overwriteGroupFieldsブーリアンデフォルトでは、値は次のように設定されています。 false.
に設定されている場合 true次に、すべてのウィジェット グループ フィールド値をデフォルトのグループ トークンで上書きします。 defaultResourceGroup & defaultWebsiteGroup.
owner文字列ダッシュボードがプライベートの場合、所有者がリストされますが、それ以外の場合、フィールドは空のままです。デフォルトは、ダッシュボードを追加したユーザーになります。
templateJSONのダッシュボードのインポートに使用されるテンプレート。注意してください。 template フィールドは、 POST API リクエスト。
groupId整数ダッシュボードが属するグループの ID。デフォルトは 1 (ルート グループ) です。
description文字列ダッシュボードの説明。
例– "description": "Windows Servers Performance"
sharableブーリアンダッシュボードが共有可能かどうかを示します。
  • If "sharable": true – ダッシュボードは公開されています。
  • If "sharable": false – ダッシュボードはプライベートです。
値は常に次のようになります true ダッシュボードがプライベート ダッシュボードでない場合。
widgetsConfigJSONのウィジェットの UI 位置で使用されるウィジェット構成に関する情報 (col、sizex、row、sizey など)。例: 
"widgetsConfig": {
"1": {
"col": 1,
"sizex": 6,
"row": 1,
"sizey": 6
},
"2": {
"col": 10,
"sizex": 3,
"row": 1,
"sizey": 6
}}
groupName文字列作成されたダッシュボードが存在するグループの名前。
例– "groupName": "Server Dashboard"
widgetTokensJSONリストダッシュボード トークンを使用すると、トークンの値を変更することで、単一のダッシュボード テンプレートをさまざまなデバイスまたは Web サイト グループに適用できます。ウィジェット トークンには、デバイスの親グループとデバイスの子グループ (確立されている場合) の名前が含まれます。フィールドには少なくともデフォルトのトークンが含まれている必要があります ##defaultResourceGroup## そして ##defaultWebsiteGroup##。カスタム トークンを追加することもできます。詳細については、を参照してください。 ダッシュボードトークンの使用.
例– “widgetTokens”:[{“name”:”defaultDeviceGroup”,”value”:”*”},{“name”:”defaultServiceGroup”,”value”:”*”}]
name文字列(必須の) ダッシュボードの名前。
例– "name": "Default Device Group"