PAScorecard - スコープ指定

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む10読むのに数分

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

    この API には パフォーマンスアナリティクス (com.snc.pa.analytics_center) アプリケーションが必要です。 詳細については、次のリンクを参照してください。

    PAScorecard - addParam(文字列 parameter, 文字列 value)

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

    同一の PAScorecard オブジェクトでこのメソッドを複数回呼び出すと、インジケーターの sys_id とブレークダウンの sys_id のように、複数のパラメータを渡すことができます。すべてのパラメーターを指定した後、query() を呼び出してクエリーを実行します。

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

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

    デフォルト：true
    display_value 文字列 参照フィールドと選択フィールドのデータ取得オペレーション。
    この値に基づいて、データベースの表示値または実際の値が取得されます。
    • true にすると、すべてのフィールドの表示値が返されます。
    • false にすると、データベースから実際の値が返されます。
    • all にすると、実際の値と表示値の両方が返されます。

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

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

    デフォルト：false
    favorites ブール クエリユーザーのお気に入りであるインジケーターのみを返すかどうかを示すフラグ。
    有効な値：
    • 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 に設定されている必要があります。
    キー ブール キーインジケーターの結果のみを返すかどうかを示すフラグ。
    有効な値：
    • true：trendline_scores 要素を返します。
    • false：trendline_scores 要素を返しません。

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

    デフォルト: 10

    最大：100
    sortby 文字列 結果をソートするときに使用する値。
    有効な値：
    • bullet
    • change
    • changeperc
    • date
    • default
    • direction
    • duedate
    • frequency
    • gap
    • gapperc
    • group
    • indicator_group
    • name
    • order
    • target
    • trend
    • 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 パラメーターは [オープン中のインシデントの数] インジケーターを指定し、breakdown パラメーターは [優先度] ブレークダウンを指定します。どちらのパラメーターも、それぞれのレコードの 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(文字列 parameter, 文字列 value) を呼び出して PAScorecard オブジェクトのパラメーターを設定します。

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

    PAScorecard - result()

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

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

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

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