前のトピック: ダッシュボード Web サービス次のトピック: データ ソース Web サービス


ダッシュボード Web サービスの構文例

ダッシュボード Web サービスのパラメータを確認するには、次のコールを発行します。

http://CA Performance Center Server IP Address:8181/pc
/center/rest/dashboards/documentation

GET メソッド(エクスポート)

GET を実行すると、CA Performance Center の別のインスタンスへのインポートに適した XML ファイルにダッシュボードがエクスポートされます。

ダッシュボードをエクスポートするには、内部的に割り当てられたページ ID が必要です。 ID の検索には製品のユーザ インターフェースを使用します。手順は以下のとおりです。

  1. エクスポートするダッシュボードに移動します。
  2. ブラウザ ウィンドウで、URL に含まれるページ ID を探します。次に例を示します。

    http://CA Performance Center Server Hostname:8181/pc/desktop/page?pg=2000040

    ページ ID は2000040です。

  3. REST クライアントで、URL を以下のように設定します。
    http://CA Performance Center Server IP address:8181/pc/center/webservice/dashboards/pageId
    
  4. GET 操作を実行します。

    エラー メッセージまたは成功メッセージがレスポンスに表示されます。

POST メソッド(インポート)

XML ファイルからダッシュボードをインポートできます。

  1. URL を以下のように設定します。
    http://CA Performance Center Server IP Address:8181/pc/center/webservice/dashboards/import
    
  2. エクスポートしたダッシュボードを表す XML ファイルを参照して選択するか、XML ファイルのエクスポート済みテキストを[Body]フィールドに貼り付けます。

    MenuItem および DashboardTitle が一意かどうかのチェックが実行されます。

  3. ファイルの最上部にある以下のプロパティを確認します。
        <menuItem>Custom Dashboards</menuItem>
        <dashboardTitle>MyCustomDashboard_Example</dashboardTitle>
    

    これらのプロパティはテナントごとに一意であることが必要です。

  4. POST 操作を実行します。

    エラー メッセージまたは成功メッセージがレスポンスに表示されます。

    : インポートされるダッシュボードには、Web サービスによってページ ID が割り当てられます。

実際にインポートする前に、ダッシュボードのインポートをテストします。 インポート操作を実行しなくても結果を表示できます。

以下のコールを発行します。

http://CA Performance Center Server IP Address:8181/pc
/center/webservice/dashboards/test/

結果には、インポートされるダッシュボードのページ ID が含まれます。

PUT メソッド(ダッシュボードの更新)

ページ ID に基づいてダッシュボードを更新できます。 ダッシュボードを変更するには XML を編集します。

  1. URL を以下のように設定します。
    http://hostname:8181/pc/center/webservice/dashboards/pageId
    
  2. ダッシュボードを表す XML ファイルを[Body]フィールドに貼り付けます。
  3. PUT 操作を実行します。

    エラー メッセージまたは成功メッセージがレスポンスに表示されます。