Utilisation des contextes
Les méthodes API doivent être exécutées directement après l’instance de BI Point, par exemple :
http://localhost:55555/api/ReportContext/GetContextReports
Liste des méthodes disponibles :
api/ReportContext/GetContextReports
La méthode affiche tous les rapports auxquels un contexte a été attribué. La valeur renvoyée est une liste d’objets contenant : l’identifiant du rapport, son nom et la liste des contextes. La liste renvoyée est au format JSON.
1. La demande
accepte une liste de contextes et une liste d’utilisateurs. Les deux paramètres sont facultatifs. Si aucun n’est précisé, la réponse renverra une liste de tous les rapports de contexte non filtrés au niveau de l’accès. L’ajout de l’identifiant ou du nom du contexte renverra les rapports affectés à ces contextes. L’ajout de l’identifiant ou du nom d’utilisateur filtrera la liste renvoyée et ne renverra que les rapports auxquels l’utilisateur a accès.
2. La réponse
est une liste d’objets de rapport regroupés par utilisateur. Les rapports auxquels l’utilisateur n’a pas accès ne sont pas renvoyés. Un objet de rapport contient Id,ReportName et une liste des contextes (Id,Name,Caption) qui y sont affectés.
api/ReportContext/GenerateLinks
la méthode génère un lien vers un rapport sur la base d’une liste de membres, d’un identifiant de rapport et d’un numéro de contexte. L’identifiant du rapport est le paramètre minimum.
1. La demande
accepte l’identifiant de rapport à ouvrir et une liste de contextes. La liste contient l’ID du contexte et une liste d’éléments à filtrer. Ces éléments peuvent avoir des champs Type et Valeur qui prennent en charge 3 types :
2. Nom unique
3. Nom affiché
4. OrgId
Si BI Point ne trouve pas un élément ou si un contexte donné n’est pas inclus dans le rapport, celui-ci s’ouvrira sans filtrer les éléments inconnus.
5. La réponse
de la méthode est un lien vers le rapport/tableau de bord avec le GUID sous lequel toutes les informations nécessaires au filtrage sont stockées
Exemple d’utilisation des méthodes
api/ReportContext/GetContextReports
1. Demandes
- de tous les rapports contextuels
{"data":"{}"}
- des rapports contextuels assignés au contexte nommé « Produit »
{"data":"{\"Contexts\":[{\"Name\":\"Produit\"}]}"}
- des rapports contextuels assignés au contexte dont l’ID est 20
{"data":"{\"Contexts\":\[{\"Id\":20}\]}"}
- des rapports contextuels assignés au contexte nommé « Produit » ou au contexte dont l’ID est 20
{"data":"{\"Contexts\":[{\"Id\":20},{\"Name\":\"Produit\"}]}"}
- de tous les rapports contextuels dosponibles à l’utilisateur dont le nom d’utilisateur est « ab »
{"data":"{\"Users\":[{\"Login\":\"ab\"}]}"}
- de tous rapports contextuels assignés à l’utilisateur dont l’ID est 14
{"data":"{\"Users\":[{\"Id\":14}]}"}
- de tous les rapports contextuels dosponibles à l’utilisateur dont le nom d’utilisateur est « ab » et dont l’ID est 14. Les rapports sont regroupés pour chaque utilisateur séparément
{"data":"{\"Users\":[{\"Login\":\"ab\"},{\"Id\":14}]}"}
- des rapports contextuels assignés au contexte dont l’ID est 20 et regroupés pour les utilisateurs dont le nom d’utilisateur est « ab » et dont l’ID est 14
{"data":"{\"Users\":[{\"Login\":\"ab\"},{\"Id\":14}],\"Contexts\":[{\"Id\":20}]}"}
2. Réponses
api/ReportContext/GenerateLinks
1. Demandes
- de génération d’un lien vers le rapport 37530
{"data":"{\"Id\":37530}"}
- d’un lien vers le rapport 37530 filtré sur l’élément avec un nom unique (Type 0) dans le contexte avec l’ID 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Produit].[Code].&[100010013]\"}]}]}"}
- d’un lien vers le rapport 37530 filtré sur l’élément avec un nom affiché (Type 1) dans le contexte avec l’ID 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":1,\"Value\":\"KAR/0024/OP\"}]}]}"}
- de génération d’un lien vers le rapport 37530 et de filtrage vers un élément avec OrgId (Type 2) dans un contexte avec l’ID 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":2,\"Value\":\"368:141\"}]}]}"}
- de génération d’un lien vers le rapport 37530 et de filtrage des éléments par nom unique, nom d’affichage et OrgId dans un contexte avec l’ID 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Produit].[Code].&[100010013]\"},{\"Type\":1,\"Value\":\"KAR/0024/OP\"},{\"Type\":2,\"Value\":\"368:141\"}]}]}"}
- de génération d’un lien vers le rapport 37530 et de filtrage des éléments par nom d’affichage dans le contexte de l’ID 12 et par nom unique, nom d’affichage et OrgId dans le contexte de l’ID 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":12,\"Members\":[{\"Type\":1,\"Value\":\"00111 test test DE-123123 Bayern\"}]},{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Produit].[Code].&[100010013]\"},{\"Type\":1,\"Value\":\"KAR/0024/OP\"},{\"Type\":2,\"Value\":\"368:141\"}]}]}"}
2. Réponses
