Aby umożliwić komunikację ze środowiskiem Planful® - dawniej Host Analytics® - za pośrednictwem opublikowanego interfejsu REST API usługi w ramach łańcucha, dodaj krok z poleceniem połączenia Planful.
Aby włączyć te polecenia, administrator IT najpierw tworzy konektor Planful.
Wyczyść dane
Aby wyczyścić dane tabeli przemieszczania na podstawie kodu reguły, użyj polecenia Clear Data.
Równoważne wywołanie API: https://help.planful.com/v1/docs/clear-data-1
Właściwości
| Właściwość |
Szczegóły |
| Zasada |
Wprowadź nazwę lub kod reguły, do której mają zostać załadowane dane. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz listę raportów
Aby pobrać listę dostępnych raportów, użyj polecenia Get Reports List.
Równoważne wywołanie API: NIE DOTYCZY
Właściwości
| Właściwość |
Szczegóły |
| Wyszukaj folder |
Wprowadź folder, z którego mają być pobierane raporty. |
| Typ raportu |
Wprowadź typ raportu do filtrowania. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Raporty |
JSON |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz wersję
Aby pobrać wersję instancji Planful, użyj polecenia Get Version.
Równoważne wywołanie API: https://help.planful.com/v1/docs/getversion-api
Właściwości
Brak
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Nazwa aplikacji |
Ciąg |
| Wersja |
Ciąg |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Załaduj dane
Aby załadować dane do tabel przejściowych aplikacji Planful, użyj polecenia Load Data.
Równoważne wywołanie API: https://help.planful.com/v1/docs/load-data-external-source-models
Właściwości
| Właściwość |
Szczegóły |
| Zasada |
Wprowadź nazwę lub kod reguły, do której mają zostać załadowane dane. |
| Dane |
Wprowadź plik zawierający dane do załadowania do Rule. Każdy wiersz powinien być osobnym wpisem. |
| Ogranicznik |
Wybierz separator używany w każdym wierszu, aby rozdzielić dane na kolumny. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz dane GL
Aby pobrać kolekcję obiektów GLData na podstawie kryteriów filtrowania, użyj polecenia Retrieve GL Data. Każdy zwrócony obiekt odpowiada wierszowi GL Data w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/gldata-retrieve-api
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| GLData (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz dane Segmentu1
Aby pobrać kolekcję obiektów Segment1 na podstawie kryteriów filtrowania, użyj polecenia Retrieve Segment1 Data. Każdy zwrócony obiekt odpowiada wierszowi danych segment1 w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/segment1-retrieve
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Dane segmentu1 (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz dane Segmentu2
Aby pobrać kolekcję obiektów Segment2 na podstawie kryteriów filtrowania, użyj polecenia Retrieve Segment2 Data. Każdy zwrócony obiekt odpowiada wierszowi danych segmentu2 w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/segment2-retrieve
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Dane segmentu2 (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz dane Segment3
Aby pobrać kolekcję obiektów Segment3 na podstawie kryteriów filtrowania, użyj polecenia Retrieve Segment3 Data. Każdy zwrócony obiekt odpowiada wierszowi danych segmentu3 w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/segment3-retrieve
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Dane segmentu3 (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobieranie danych Segment4
Aby pobrać kolekcję obiektów Segment4 na podstawie kryteriów filtrowania, użyj polecenia Retrieve Segment4 Data. Każdy zwrócony obiekt odpowiada wierszowi danych segmentu4 w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/segment4-retrieve
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Dane Segment4 (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz dane Segment5
Aby pobrać kolekcję obiektów Segment5 na podstawie kryteriów filtrowania, użyj polecenia Retrieve Segment5 Data. Każdy zwrócony obiekt odpowiada wierszowi danych segmentu5 w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/segment5-retrieve
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Dane segmentu5 (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz dane Segment6
Aby pobrać kolekcję obiektów Segment6 na podstawie kryteriów filtrowania, użyj polecenia Retrieve Segment6 Data. Każdy zwrócony obiekt odpowiada wierszowi danych segmentu6 w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/segment6-retrieve
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Dane segmentu6 (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz dane Segment7
Aby pobrać kolekcję obiektów Segment7 na podstawie kryteriów filtrowania, użyj polecenia Retrieve Segment7 Data. Każdy zwrócony obiekt odpowiada wierszowi danych segmentu7 w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/segment7-retrieve
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Dane segmentu7 (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Pobierz dane Segment8
Aby pobrać kolekcję obiektów Segment8 na podstawie kryteriów filtrowania, użyj polecenia Retrieve Segment8 Data. Każdy zwrócony obiekt odpowiada wierszowi danych segment8 w bazie danych.
Równoważne wywołanie API: https://help.planful.com/v1/docs/segment8-retrieve
Właściwości
| Właściwość |
Szczegóły |
| Filtry |
Wprowadź filtry testowe. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Dane Segment8 (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Uruchom raport
Aby uruchomić raport i zwrócić jego wyniki w formacie JSON, użyj polecenia Run Report.
Równoważne wywołanie API: NIE DOTYCZY
Właściwości
| Właściwość |
Szczegóły |
| Kod raportu |
Wprowadź nazwę lub kod raportu do uruchomienia. |
| Pochodzenie |
Wprowadź lokalizację raportu w aplikacji Planful. Użyj // jako separatorów w ścieżce. |
| Nazwa kostki |
Wprowadź nazwę kostki powiązanej z raportem. |
| Filtry |
Wprowadź filtry, które mają zostać zastosowane do raportu. |
| Zastosuj filtry |
Wybierz, czy chcesz zastosować filtry. |
Dane wyjściowe
| Dane wyjściowe |
Typ wyjścia |
| Raport |
JSON |
| Raport (CSV) |
Plik |
| Liczba rekordów |
Liczba całkowita |
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |
Przesyłanie danych
Aby przenieść dane tabeli przejściowej do tabeli docelowej w Planful na podstawie kodu reguły, użyj polecenia Transfer Data.
Równoważne wywołanie API: https://help.planful.com/v1/docs/new-transfer-data-rest-api
Właściwości
| Właściwość |
Szczegóły |
| Zasada |
Wprowadź nazwę (kod) reguły, do której mają zostać załadowane dane |
Dane wyjściowe
Brak
Kody wyjścia
| Kod |
Typ |
Szczegóły |
| 0 |
Powodzenie |
Powodzenie |
| 1 |
Błąd |
Wystąpił błąd |