PAScorecard : dans le champ d’application
L’API PAScorecard vous permet d’extraire des données sur les indicateurs et leurs enregistrements associés, tels que les répartitions.
Cette API nécessite l’application Analyse des performances (com.snc.pa.analytics_center) et s’exécute dans l’espace de noms SNC .
PAScorecard : addParam(paramètre de chaîne, valeur de chaîne)
Ajoute un paramètre de requête pour filtrer les scores renvoyés.
Appelez cette méthode plusieurs fois sur le même objet PAScorecard pour transmettre plusieurs paramètres, tels que le sys_id d’indicateur et une sys_id de répartition. Après avoir spécifié tous les paramètres, appelez query() pour exécuter la requête.
Si vous interrogez un objet PAScorecard sans paramètres, l’API renvoie une liste de tous les indicateurs affichés sur le Centre d'analyse, avec leurs scores.
| Nom | Type | Description |
|---|---|---|
| répartition | Chaîne | Sys_id d’une répartition pour renvoyer des informations de graphique organisées telles que définies par la répartition. Par exemple, la sys_id d’une répartition des priorités pour renvoyer des informations de diagramme des tâches distinctes pour chaque valeur de priorité, telles que le nombre d’incidents ouverts/Priorité/2 : élevée. |
| breakdown_relation | Chaîne | Spécifiez l’sys_id d’une relation de répartition pour répartir les données renvoyées à l’aide de cette relation. Vous pouvez afficher les relations de répartition disponibles en définissant le include_available_breakdowns paramètre sur vrai. |
| contient | Chaîne | Liste de noms ou de descriptions séparés par des virgules pour renvoyer des résultats uniquement à partir d’indicateurs ayant une valeur correspondante. Tous les éléments de liste séparés par des virgules doivent correspondre, sinon aucun résultat n’est renvoyé : la liste suit la logique ET, pas la logique OR. |
| affichage | Chaîne | Marqueur qui indique le type d’indicateurs à renvoyer. Valeurs valides :
Par défaut : true |
| display_value | Chaîne | Opération de récupération de données pour les champs de référence et de choix. Sur la base de cette valeur, la valeur d’affichage et/ou la valeur réelle dans la base de données sont récupérées.
Valeur par défaut : false |
| elements_filter | Chaîne | Spécifiez la sys_id d’un filtre d’éléments pour appliquer ce filtre aux données renvoyées. Type de données : chaîne |
| exclude_reference_link | Booléen | Marqueur indiquant s’il faut masquer les informations supplémentaires fournies pour les champs de référence, telles que l’URI de la ressource de référence. Valeurs valides :
Valeur par défaut : false |
| Favoris | Booléen | Marqueur indiquant s’il faut renvoyer uniquement les indicateurs qui sont les favoris de l’utilisateur ayant effectué l’interrogation. Valeurs valides :
Valeur par défaut : false |
| de | Chaîne | Date la plus ancienne à partir de laquelle renvoyer les scores. Seuls les scores à partir de cette date ou d’une date ultérieure sont renvoyés.
Ce paramètre nécessite que include_scores soit défini sur vrai. Format : Norme ISO-8601 |
| include_available_aggregates | Chaîne | Marqueur indiquant s’il faut renvoyer tous les agrégats disponibles pour un indicateur lorsqu’aucun agrégat n’a été appliqué. Valeurs valides :
Valeur par défaut : false |
| include_available_breakdowns | Booléen | Marqueur indiquant s’il faut renvoyer toutes les répartitions disponibles pour un indicateur. Valeurs valides :
Valeur par défaut : false |
| include_forecast_scores | Booléen | Marqueur indiquant s’il faut renvoyer l’élément forecast_scores qui contient un tableau de paires date-valeur qui définissent les données de prévision pour le Centre d'analyse . Ce paramètre nécessite que include_scores soit défini sur vrai. Valeurs valides :
Valeur par défaut : false |
| include_realtime | Booléen | Marqueur indiquant s’il faut renvoyer l’élément realtime_enabled qui indique si les scores en temps réel sont activés pour l’indicateur et l’élément realtime_value qui contient la valeur de score en temps réel. Ce paramètre n’est pas pris en charge pour les indicateurs de formule. Valeurs valides :
Valeur par défaut : false |
| include_scores | Booléen | Marqueur indiquant s’il faut renvoyer des scores d’indicateur pour l’ensemble de la plage horaire sélectionnée sur le Centre d'analyse . Si aucune valeur n’est spécifiée, ce paramètre est défini par défaut sur faux et renvoie uniquement la valeur de score la plus récente. Pour contraindre la plage de dates des scores renvoyés, combinez ce paramètre avec from et to. Valeurs valides :
Valeur par défaut : false |
| include_target_color_scheme | Booléen | Marqueur indiquant s’il faut renvoyer l’élément target_color_scheme qui contient les valeurs minimale et maximale, ainsi que la couleur de chaque section de la combinaison de couleurs cible pour le Centre d'analyse . Valeurs valides :
Valeur par défaut : false |
| include_trendline_scores | Chaîne | Marqueur indiquant s’il faut renvoyer l’élément trendline_scores qui contient un tableau de paires date-valeur qui définissent la Centre d'analyse courbe de tendance. Ce paramètre nécessite que include_scores soit défini sur vrai. |
| clé | Booléen | Marqueur indiquant s’il faut renvoyer des résultats uniquement pour les indicateurs clés. Valeurs valides :
Valeur par défaut : false |
| limite | Numéro | Nombre maximum de scores à renvoyer. |
| Page | Chaîne | Spécifiez le numéro de page. Par exemple, lors de l’interrogation de 20 indicateurs avec Centre d'analyse la valeur de per_page par défaut (10), spécifiez une valeur de page de 2 pour récupérer le Centre d'analyse pour 11-20. |
| per_page | Numéro | Nombre maximal d’indicateurs qu’une requête peut renvoyer sur une page. Valeur par défaut : 10 Maximum : 100 |
| trier par | Chaîne | Valeur à utiliser lors du tri des résultats. Valeurs valides :
Valeur par défaut : value |
| répertoire de tri | Chaîne | Sens de tri. Valeurs valides :
Par défaut : décroissant |
| étape | Numéro | Valeur numérique permettant d’ignorer les scores, en fonction de la fréquence de l’indicateur. Par exemple, spécifiez une valeur de 3 pour renvoyer uniquement les scores tous les trois jours pour un indicateur quotidien, ou toutes les trois semaines pour un indicateur hebdomadaire. |
| balises | Chaîne | Entrez un groupe d’indicateurs sys_id pour renvoyer les indicateurs de ce groupe. Ne pas utiliser uuid avec ce paramètre. |
| target | Booléen | Marqueur indiquant s’il faut renvoyer des résultats uniquement pour les indicateurs qui ont une cible définie sur le Centre d'analyse . Valeurs valides :
Valeur par défaut : false |
| à | Chaîne | Dernière date à partir de laquelle renvoyer des scores. Seuls les scores à partir de cette date ou d’une date antérieure sont renvoyés. Ce paramètre nécessite que include_scores soit défini sur vrai. |
| uuid | Chaîne | Saisissez une liste de valeurs de sys_id séparées par deux-points pour spécifier les indicateurs, répartitions, agrégats et domaines à interroger. Le paramètre suit le format suivant : <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> Le paramètre doit commencer par la sys_id d’un enregistrement d’indicateur. Vous pouvez éventuellement ajouter les valeurs sys_id d’une répartition et un élément de répartition pour regrouper la réponse en fonction de la répartition, ainsi que la sys_id d’un agrégat pour appliquer cet agrégat. Vous pouvez utiliser une répartition avec un agrégat ou n’en utiliser qu’un. Pour plus d’informations sur l’obtention des valeurs sys_id des enregistrements, voir Identificateur d’enregistrement unique (sys_id). Remarque : Si un indicateur est configuré pour utiliser des séries chronologiques par défaut, toutes les Centre d'analyse valeurs de cet indicateur utilisent cette agrégation de série chronologique. |
| Type | Description |
|---|---|
| Néant |
Dans cet exemple, le paramètre uuid spécifie l’indicateur Nombre d’incidents ouverts et le paramètre Répartition spécifie la répartition des priorités. Les deux paramètres ont la sys_id de leurs enregistrements respectifs comme valeurs. La fonction query() renvoie les résultats sous forme d’objet.
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()
Effectuez une requête basée sur les paramètres spécifiés et renvoyez les résultats sous forme d’objet.
Avant d’appeler cette méthode, configurez les paramètres de l’objet PAScorecard en appelant addParam(String parameter, String value).
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Objet | L’objet PAScorecard. |
PAScorecard : résultat()
Obtenir le résultat de la dernière requête sous forme d’objet.
Cette méthode n’effectue pas de requête. Pour effectuer une requête avant de renvoyer le résultat, utilisez query().
Cette fonction ne peut pas s’exécuter dans un champ d’application autre que global.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Objet | Les résultats de la dernière requête, renvoyés en tant qu’objet JS. |