PAScorecard - スコープ対象

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：10分

    • PAScorecard API を使用すると、インジケーターとそれに関連するレコード (ブレークダウンなど) に関するデータをフェッチできます。

    この API は パフォーマンスアナリティクス (com.snc.pa.analytics_center) アプリケーションを必要とし、 SNC 名前空間で実行されます。

    PAScorecard - addParam(文字列パラメーター, 文字列値)

    返されたスコアをフィルタリングするクエリパラメーターを追加します。

    同じ PAScorecard オブジェクトでこのメソッドを複数回呼び出して、インジケーター sys_idやブレークダウンsys_idなどの複数のパラメーターを渡します。すべてのパラメーターを指定したら、 query() を呼び出してクエリを実行します。

    パラメーターなしで PAScorecard オブジェクトをクエリーすると、API は、 アナリティクスハブに表示されているすべてのインジケーターのリストを、そのスコアとともに返します。

    表 : 1. パラメーター
    名前 タイプ 説明
    ブレークダウン 文字列 ブレークダウンのSys_idで、ブレークダウンの定義に従って整理されたグラフ情報を返します。たとえば、オープン中のインシデントの数/優先度/2 - 高など、優先度値ごとに個別のタスクチャート情報を返す優先度ブレークダウンのsys_idなどです。
    breakdown_relation 文字列 ブレークダウンの関連付けのsys_idを指定すると、その関連付けを使用して返されたデータがブレークダウンされます。include_available_breakdownsパラメーターを true に設定すると、利用可能なブレークダウンの関連付けを表示できます。
    次の値を含む 文字列 一致する値を持つインジケーターからのみ結果を返す名前または説明のカンマ区切りリスト。すべてのカンマ区切りリストアイテムが一致する必要があります。一致しないと結果が返されません:リストは OR ロジックではなく AND ロジックに従います。
    表示 文字列 返されるインジケーターのタイプを示すフラグ。
    有効な値：
    • true: アナリティクスハブ に表示されるインジケーターのみを返します。
    • all:すべてのインジケーターを返します。

    デフォルト：true
    display_value 文字列 参照フィールドと選択フィールドのデータ取得操作。
    この値に基づいて、データベース内の表示値や実際の値が取得されます。
    • true を指定すると、すべてのフィールドの表示値が返されます。
    • false は、データベースから実際の値を返します。
    • すべては 実際の値と表示値の両方を返します。

    デフォルト値：false
    elements_filter 文字列 返されたデータにそのフィルターを適用する要素フィルターのsys_idを指定します。

    データタイプ：文字列
    exclude_reference_link ブーリアン 参照リソースへの URI など、参照フィールドに提供された追加情報を非表示にするかどうかを示すフラグ。
    有効な値：
    • true:参照フィールドに指定された追加情報を非表示にします。
    • false:参照フィールドに提供された補足情報を非表示にしません。

    デフォルト値：false
    お気に入り ブーリアン クエリを実行しているユーザーのお気に入りであるインジケーターのみを返すかどうかを示すフラグ。
    有効な値：
    • true:クエリを実行しているユーザーのお気に入りのインジケーターのみを返します。
    • false:すべてのインジケーターを返します。

    デフォルト値：false
    送信元 文字列 スコアを返す最も早い日付。この日付以降のスコアのみが返されます。

    このパラメーターでは、 include_scores を true に設定する必要があります。

    フォーマット:ISO-8601規格
    include_available_aggregates 文字列 集計が適用されていない場合に、インジケーターで利用可能なすべての集計を返すかどうかを示すフラグ。
    有効な値：
    • true:集計が適用されていない場合に、インジケーターで利用可能なすべての集計を返します。
    • false:集計を返しません。

    デフォルト値：false
    include_available_breakdowns ブーリアン インジケーターで利用可能なすべてのブレークダウンを返すかどうかを示すフラグ。
    有効な値：
    • true:インジケーターで利用可能なすべてのブレークダウンを返します。
    • false:ブレークダウンを返しません。

    デフォルト値：false
    include_forecast_scores ブーリアン アナリティクスハブ の予測データを定義する日付と値のペアのアレイを含むforecast_scores要素を返すかどうかを示すフラグ。

    このパラメーターでは、 include_scores を true に設定する必要があります。

    有効な値：
    • true:forecast_scores要素を返します。
    • false:forecast_scores要素を返しません。

    デフォルト値：false
    include_realtime ブーリアン インジケーターに対してリアルタイムスコアが有効になっているかどうかを示すrealtime_enabled要素と、リアルタイムスコア値を含むrealtime_value要素を返すかどうかを示すフラグ。このパラメーターは、式インジケーターではサポートされていません。
    有効な値：
    • true:realtime_enabled要素を返します。
    • false:realtime_enabled要素を返しません。

    デフォルト値：false
    include_scores ブーリアン アナリティクスハブ で選択された全時間範囲のインジケータースコアを返すかどうかを示すフラグ。値が指定されていない場合、このパラメーターのデフォルトは false で、最新のスコア値のみを返します。

    返されるスコアの日付範囲を制限するには、このパラメーターを from および to と組み合わせます。

    有効な値：
    • true:選択した時間範囲全体のインジケータースコアを返します。
    • false:選択した時間範囲全体のインジケータースコアを返しません。

    デフォルト値：false
    include_target_color_scheme ブーリアン 最小値と最大値、および アナリティクスハブ のターゲット配色の各セクションの色を含むtarget_color_scheme要素を返すかどうかを示すフラグ。
    有効な値：
    • true:target_color_scheme要素を返します。
    • false:target_color_scheme要素を返しません。

    デフォルト値：false
    include_trendline_scores 文字列 アナリティクスハブ トレンドラインを定義する日付と値のペアのアレイを含むtrendline_scores要素を返すかどうかを示すフラグ。

    このパラメーターでは、 include_scores を true に設定する必要があります。
    key ブーリアン キーインジケーターのみの結果を返すかどうかを示すフラグ。
    有効な値：
    • true:trendline_scores要素を返します。
    • false:trendline_scores要素を返しません。

    デフォルト値：false
    limit 番号 返すスコアの最大数。
    ページ 文字列 ページ番号を指定します。たとえば、デフォルトのper_page値 (10) で アナリティクスハブ 内の 20 個のインジケーターを照会する場合、ページ値 2 を指定すると、11 から 20 の アナリティクスハブ が取得されます。
    per_page 番号 各クエリがページ上で返すことができるインジケーターの最大数。

    デフォルト：10

    最大:100
    ソート基準 文字列 結果をソートするときに使用する値。
    有効な値：
    • ブレット
    • 変更
    • changeperc
    • date
    • デフォルト
    • direction
    • 期限
    • 周期
    • gap
    • gapperc
    • グループ
    • indicator_group
    • name
    • order
    • target
    • 傾向
    • value

    デフォルト:value
    sortdir 文字列 ソートの方向。
    有効な値：
    • asc:昇順を示します
    • des:降順を示します

    デフォルト:降順
    ステップ 番号 インジケーターの頻度に基づいて、スコアをスキップする数値。たとえば、値 3 を指定すると、日次インジケーターの場合は 3 日ごとのスコアのみを返し、週次インジケーターの場合は 3 週ごとのスコアのみを返します。
    タグ 文字列 インジケーターグループsys_idを入力して、そのグループのインジケーターを返します。このパラメーターで uuid を使用しないでください。
    target ブーリアン アナリティクスハブ にターゲットが設定されているインジケーターの結果のみを返すかどうかを示すフラグ。
    有効な値：
    • true:ターゲットが設定されているインジケーターの結果のみを返します。
    • false:該当するすべてのインジケーターの結果を返します。

    デフォルト値：false
    次へ 文字列 スコアを返す最新の日付。この日付以前のスコアのみが返されます。

    このパラメーターでは、 include_scores を true に設定する必要があります。
    uuid 文字列 sys_id値のコロン区切りリストを入力して、クエリするインジケーター、ブレークダウン、集計、およびドメインを指定します。パラメーターの形式は次のとおりです。

    <indicator_sys_id>:<breakdown_sys_id>:<elements_filter_sys_id or element_sys_ids>:<lvl-2 breakdown_sys_id>:<lvl-2 elements_filter_sys_id or element_sys_ids>:<aggregate_sys_id>;<domain_sys_id>

    パラメーターは、インジケーターレコードのsys_idで始まる必要があります。必要に応じて、ブレークダウンとブレークダウン要素のsys_id値を追加して、ブレークダウンに基づいて応答をグループ化し、その集計を適用する集計のsys_idを追加できます。アグリゲートでブレークダウンを使用することも、アグリゲートのみを使用することもできます。

    レコードのsys_id値を取得する方法については、「 一意のレコード識別子 (sys_id)」を参照してください。

    注:
    インジケーターが デフォルトの時系列を使用するように構成されている場合、そのインジケーターのすべての アナリティクスハブ 値でその時系列アグリゲーションが使用されます。
    表 : 2. 返される内容
    タイプ 説明
    なし

    この例では、uuid パラメーターはオープンインシデント数インジケーターを指定し、ブレークダウンパラメーターは優先度ブレークダウンを指定します。どちらのパラメーターにも、それぞれのレコードのsys_idが値として含まれています。query() 関数は結果をオブジェクトとして返します。

    var sc = new SNC.PAScorecard(); //in a scoped app, do not use the SNC namespace
sc.addParam('uuid', 'fb007202d7130100b96d45a3ce6103b4');       // Number of open incidents
sc.addParam('breakdown', '0df47e02d7130100b96d45a3ce610399');  // by Priority
var result = sc.query();  // Query results, which are returned as an object
for (var i = 0; i < result.length; i++)
gs.info(result[i].name + ': ' + result[i].value + ' ' + result[i].unit.display_value);

    PAScorecard - query()

    指定されたパラメーターに基づいてクエリを実行し、結果をオブジェクトとして返します。

    このメソッドを呼び出す前に、 addParam(String parameter, String value) を呼び出して PAScorecard オブジェクトのパラメーターを構成します。

    表 : 3. パラメーター
    名前 タイプ 説明
    なし
    表 : 4. 返される内容
    タイプ 説明
    オブジェクト PAScorecard オブジェクト。

    PAScorecard - result()

    最後のクエリ結果をオブジェクトとして取得します。

    このメソッドはクエリを実行しません。結果を返す前にクエリを実行するには、 query() を使用します。

    この関数はグローバル以外のスコープでは実行できません。

    表 : 5. パラメーター
    名前 タイプ 説明
    なし
    表 : 6. 返される内容
    タイプ 説明
    オブジェクト JS オブジェクトとして返される最後のクエリの結果。