Ogólne informacje

Tworzenie i pobieranie raportów w MGBI API

Dane z poszczególnych modeli dostępnych w MGBI API mogą być eksportowane do plików w różnych formatach, które nazywamy raportami.

Proces tworzenia i pobierania raportów

1. Utworzenie raportu

Aby utworzyć raport, należy użyć endpointu Create Report i wskazać model danych oraz pozostałe parametry, jakie powinny spełniać rekordy uwzględnione w raporcie:

{
    "name": [nazwa raportu],
    "query": {
        "model": [identyfikator modelu],
        [parametr]: [wartość]
    },
    "file_format": [format pliku],
    "file_password": [hasło do pliku]
}

Przy tworzeniu raportów dla poszczególnych modeli można korzystać ze wszystkich parametrów dostępnych w odpowiadających im endpointach Get Records.

Po utworzeniu raportu endpoint zwraca jego parametry:

{
    "id": [identyfikator raportu],
    "name": [nazwa raportu],
    "query": {
        "model": [identyfikator modelu],
        [parametr]: [wartość]
    },
    "file_format": [format pliku],
    "file_password": [hasło do pliku],
    "creation_datetime": [data i czas utworzenia],
    "progress": [postęp generowania raportu],
    "status": [status generowania raportu]
}

Nowy raport powinien zostać wygenerowany w czasie od kilku do kilkudziesięciu sekund od momentu jego utworzenia.

2. Pobieranie statusu generowania raportu

Aby sprawdzić status generowania raportu, należy użyć endpointu Get Report By Id podając w parametrze id uzyskany w poprzednim kroku identyfikator raportu.

W odpowiedzi endpoint zwraca aktualne parametry raportu:

{
    "id": [identyfikator raportu],
    "name": [nazwa raportu],
    "query": {
        "model": [identyfikator modelu],
        [parametr]: [wartość]
    },
    "file_format": [format pliku],
    "file_password": [hasło do pliku],
    "creation_datetime": [data i czas utworzenia],
    "progress": [postęp generowania raportu],
    "status": [status generowania raportu]
}

Jeśli parametr status przyjmuje wartość success, oznacza to, że raport został wygenerowany i jest gotowy do pobrania.

3. Pobieranie raportu

Aby pobrać raport, należy użyć endpointu Download Report i przekazać w parametrze report_id jego identyfikator.

Tworzenie i pobieranie raportów w MGBI API#

Proces tworzenia i pobierania raportów#

1. Utworzenie raportu#

2. Pobieranie statusu generowania raportu#

3. Pobieranie raportu#

Tworzenie i pobieranie raportów w MGBI API

Proces tworzenia i pobierania raportów

1. Utworzenie raportu

2. Pobieranie statusu generowania raportu

3. Pobieranie raportu