Użycie kontekstów
Metody API należy wykonywać bezpośrednio po instancji BI Point np. http://localhost:55555/api/ReportContext/GetContextReports
Lista dostępnych metod:
api/ReportContext/GetContextReports
metoda wyświetla wszystkie raporty, do których został przypisany kontekst. Wartość zwracana jest lista obiektów zawierająca: id raportu, nazwę oraz listę kontekstów. Zwracana lista jest w formacie JSON
1. Żądanie
przyjmuje listę kontekstów i listę użytkowników. Oba parametry są opcjonalne, gdy nie podamy żadnego to w odpowiedzi dostaniemy listę wszystkich raportów kontekstowych nie przefiltrowaną pod względem dostępu. Dodanie id kontekstu albo jego nazwę spowoduje zwrócenie raportów przypisanych do tych kontekstów. Dodanie id użytkownika albo jego login przefiltruje zwracaną listę i zwróci tylko te raporty do których użytkownik ma dostęp.
2. Odpowiedź
z metody to lista obiektów raportów pogrupowana po użytkownikach. Nie są zwracane raporty do których użytkownik nie ma dostępu. Obiekt raportu zawiera Id,ReportName, i listę kontekstów (Id,Name,Caption) do niego przypisanych.
api/ReportContext/GenerateLinks
metoda generuje link do raportu na podstawie listy member’ów, id raportu i nr kontekstu. Minimalna liczba parametrów do podania to id raportu.
1. Żądanie
przyjmuje Id raportu do otwarcia oraz listę kontekstów. Lista ta zawiera Id kontekstu oraz listę elementów do za filtrowania. Elementy te mogą pola Typ i Value gdzie obsługujemy 3 typy:
2. Nazwa unikatowa
3. Nazwa wyświetlana
4. OrgId
Jeśli BI Point nie znajdzie jakiegoś elementu albo podany będzie kontekst nie wpięty do raportu raport otworzy się nie za filtrując się do nieznalezionych elementów
5. Odpowiedź
z metody to link do raportu/dashboardu z GUID pod którym przechowane są wszystkie informacje niezbędne do filtrowania
Przykład użycia metod
api/ReportContext/GetContextReports
1.Żądania
- żądanie o wszystkie raporty kontekstowe.
{"data":"{}"}
- żądanie o raporty kontekstowe przypisane do kontekstu o nazwie „Produkt”.
{"data":"{\"Contexts\":[{\"Name\":\"Produkt\"}]}"}
- żądanie o raporty kontekstowe przypisanie do kontekstu o id 20.
{"data":"{\"Contexts\":\[{\"Id\":20}\]}"}
- żądanie o raporty kontekstowe przypisane do kontekstu o nazwie „Produkt” lub do kontekstu o id 20.
{"data":"{\"Contexts\":[{\"Id\":20},{\"Name\":\"Produkt\"}]}"}
- zapytanie o wszystkie raporty kontekstowe dostępne dla użytkownika o loginie „ab”.
{"data":"{\"Users\":[{\"Login\":\"ab\"}]}"}
- zapytanie o wszystkie raporty kontekstowe dostępne dla użytkownika o id 14.
{"data":"{\"Users\":[{\"Id\":14}]}"}
- zapytanie o wszystkie raporty kontekstowe dostępne dla użytkownika o loginie ab oraz użytkownika o id 14. Raporty są zgrupowanie dla każdego użytkownika osobno.
{"data":"{\"Users\":[{\"Login\":\"ab\"},{\"Id\":14}]}"}
- zapytanie o raporty kontekstowe przypisane do kontekstu o id 20 i zgrupowane dla użytkowników o loginie „ab” i id 14.
{"data":"{\"Users\":[{\"Login\":\"ab\"},{\"Id\":14}],\"Contexts\":[{\"Id\":20}]}"}
2.Odpowiedzi
api/ReportContext/GenerateLinks
1.Żądania
- wygenerowanie linku do raportu 37530
{"data":"{\"Id\":37530}"}
- wygenerowanie linku do raportu 37530 i za filtrowanie do elementu o nazwie unikatowej (Typ 0) w kontekście o id 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Produkt].[Kod].&[100010013]\"}]}]}"}
- wygenerowanie linku do raportu 37530 i za filtrowanie do elementu o nazwie wyświetlanej (Typ 1) w kontekście o id 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":1,\"Value\":\"KAR/0024/OP\"}]}]}"}
- wygenerowanie linku do raportu 37530 i za filtrowanie do elementu o OrgId (Typ 2) w kontekście o id 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":2,\"Value\":\"368:141\"}]}]}"}
- wygenerowanie linku do raportu 37530 i za filtrowanie do elementów po nazwie unikatowej, nazwie wyświetlanej i OrgId w kontekście o id 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Produkt].[Kod].&[100010013]\"},{\"Type\":1,\"Value\":\"KAR/0024/OP\"},{\"Type\":2,\"Value\":\"368:141\"}]}]}"}
- wygenerowanie linku do raportu 37530 i za filtrowanie do elementów po nazwie wyświetlanej w kontekście o id 12 oraz po nazwie unikatowej, nazwie wyświetlanej i OrgId w kontekście o id 20
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":12,\"Members\":[{\"Type\":1,\"Value\":\"00111 test test DE-123123 Bayern\"}]},{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Produkt].[Kod].&[100010013]\"},{\"Type\":1,\"Value\":\"KAR/0024/OP\"},{\"Type\":2,\"Value\":\"368:141\"}]}]}"}
2.Odpowiedzi
