FoxInsights (wersja zapoznawcza)
Wprowadzanie danych zbiorników foxInsights do przepływów i aplikacji biznesowych. Pobieranie urządzeń, poziomów wypełnienia i najnowszych odczytów, wyzwalanie zamówień lub alertów, gdy zbiornik działa nisko, i zachowaj partnerów, klientów, produktów i ustawień zbiornika w synchronizacji z erp lub CRM.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Contact | |
|---|---|
| Name | Pomoc techniczna dla partnerów usługi FoxInsights |
| adres URL | https://www.foxinsights.ai/en/contact |
| partner-support@foxinsights.ai |
| Metadane łącznika | |
|---|---|
| Publisher | FoxInsights |
| Website | https://www.foxinsights.ai |
| Zasady ochrony prywatności | https://www.foxinsights.ai/en/privacy |
| Categories | Internet rzeczy; Dane |
FoxInsights
Przeprowadź dane czołgu FoxInsights do Power Automate, Power Apps i Copilot Studio, a następnie przejdź przez nie do Dynamics 365. Pobieranie urządzeń, poziomów wypełnienia i najnowszych odczytów, wyzwalanie zamówień lub alertów, gdy zbiornik działa nisko, i zachowaj partnerów, klientów, produktów i ustawień zbiornika w synchronizacji z erp lub CRM.
Publisher: FoxInsights
Prerequisites
- Konto partnera usługi FoxInsights z włączonym interfejsem API partnera. Skontaktuj się z nim partner-support@foxinsights.ai , aby go włączyć.
- Poświadczenia interfejsu API partnera (identyfikator klienta i klucz tajny klienta) utworzone w portalu Usługi FoxInsights w obszarze Ustawienia > Interfejs API partnera.
Obsługiwane operacje
Partners
- Lista partnerów: partner, który jest właścicielem poświadczeń i wszystkich partnerów podrzędnych jako listy płaskiej.
- Pobieranie drzewa partnerów: tych samych partnerów co zagnieżdżone drzewo.
- Uzyskiwanie partnera / Wyszukaj partnerów według identyfikatora wewnętrznego.
- Tworzenie partnera, zmienianie nazwy partnera, aktualizowanie identyfikatora wewnętrznego partnera, Ustawianie wiadomości e-mail z powiadomieniami partnerskimi, Ustawianie produktów partnerskich.
Urządzenia
- Uzyskiwanie urządzeń partnerskich: urządzenia jednego partnera z bieżącym poziomem wypełnienia i najnowszym pomiarem. Urządzenia podrzędnych partnerów nie są uwzględniane.
- Pobierz urządzenie, Pobierz urządzenia użytkownika, Wyszukaj urządzenia według identyfikatora wewnętrznego, Wyszukaj urządzenia według firmy, Pobierz stan anulowania urządzenia.
- Aktualizowanie nazwy urządzenia i notatek, Aktualizowanie adresu urządzenia, Ustawianie etykiet urządzeń, Aktualizowanie powiadomień o urządzeniach, Blokowanie lub odblokowywanie urządzenia, Przenoszenie urządzenia do partnera, Zmienianie produktu urządzenia, Anulowanie kontraktu urządzenia.
- Ustaw zbiornik niestandardowy, ustaw zbiornik katalogowy, zestaw silosów, konfigurację zbiornika usuwania.
Klienci końcowi
- Pobierz użytkownika, Pobierz użytkownika pocztą e-mail, Wyszukaj użytkowników według identyfikatora wewnętrznego, Wyszukaj użytkowników według pola niestandardowego.
- Utwórz użytkownika, zaktualizuj użytkownika, przypisz urządzenie do użytkownika, copisuj urządzenie od użytkownika.
Products
- Wyszukaj produkty według kodu, Pobierz typy produktów, Pobierz wstępnie zdefiniowane typy zbiorników.
- Utwórz produkt, Zaktualizuj produkt.
Uzyskiwanie poświadczeń
- Zaloguj się do portalu Usługi FoxInsights jako administrator partnera.
- Otwórz interfejs API partnera ustawień > i wybierz pozycję Nowe poświadczenia.
- Skopiuj identyfikator klienta i klucz tajny klienta. Tajemnica jest pokazywana tylko raz.
Poświadczenia zapewniają dostęp do partnera, który je utworzył i wszystkich jego partnerów podrzędnych. Utwórz oddzielne poświadczenia dla każdej integracji, aby można je było odwołać niezależnie.
Wprowadzenie
- Utwórz połączenie z identyfikatorem klienta i kluczem tajnym klienta. Łącznik automatycznie żąda tokenów dostępu; nie trzeba wprowadzać ani odnawiać tokenu.
- Dodaj partnerów listy do przepływu i pętli na wynik za pomocą polecenia Zastosuj do każdego.
- W pętli dodaj pozycję Pobierz urządzenia partnerskie z identyfikatorem partnera z pętli .
- Zamapuj pola urządzenia na system docelowy, na przykład tabelę Dataverse lub rekord Business Central kluczem według identyfikatora sprzętu.
Znane problemy i ograniczenia
- Listy urządzeń są zwracane dla każdego partnera bez stronicowania. Aby zakryć drzewo partnerów, wywołaj metodę Pobierz urządzenia partnerskie dla każdego partnera z listy partnerów.
- Dostępna jest tylko najnowsza miara; nie ma historii pomiarów.
- Mierzona w czasie najnowszej niezawodnej miary, a nie czasu ostatniej synchronizacji. Urządzenie bez pomiaru nie ma mierzonego w poziomie; jego poziom wypełnienia można zgłosić jako 0, więc przed użyciem poziomu wypełnienia sprawdź wartość Mierzona.
- Poziomy wypełnienia mogą przekraczać 100 procent.
- Ustaw etykiety urządzeń, Ustaw wiadomości e-mail dla partnerów i Ustaw produkty partnerskie zastąp całą listę.
- Nieprzypisane urządzenie od użytkownika usuwa ustawienia adresu urządzenia i zbiornika, chyba że ustawienia urządzenia zostały ustawione.
- Tworzenie partnera, tworzenie użytkownika i tworzenie produktu nie jest bezpieczne, aby ponowić próbę: powtarzające się wywołanie powoduje utworzenie duplikatu lub niepowodzenie.
- Anulowanie kontraktu urządzenia nie może zostać cofnięte za pośrednictwem łącznika.
- Limity szybkości interfejsu API partnera mają zastosowanie na poświadczenia; odpowiedź 429 oznacza, że osiągnięto limit.
Często zadawane pytania
Czy łącznik przechowuje dane usługi FoxInsights?
No. Każda akcja odczytuje lub zapisuje dane usługi FoxInsights w momencie jego uruchomienia.
Czy jedno połączenie może zobaczyć kilku partnerów?
Yes. Połączenie widzi partnera, który utworzył poświadczenia i wszystkich jego partnerów podrzędnych.
Gdzie mogę uzyskać pomoc?
Skontaktuj się z partner-support@foxinsights.ainami .
Instrukcje dotyczące wdrażania
Wdróż łącznik jako łącznik niestandardowy za pomocą interfejsu wiersza polecenia platformy Power Platform:
pac connector create --api-definition-file apiDefinition.swagger.json --api-properties-file apiProperties.json --script-file script.csx
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Wartość domyślna
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Opis | Required |
|---|---|---|---|
| identyfikator klienta | securestring | Identyfikator klienta poświadczeń interfejsu API partnera utworzonych w usłudze FoxInsights w obszarze Interfejs API partnera ustawień > | True |
| Tajemnica klienta | securestring | Wpis tajny klienta poświadczeń interfejsu API partnera | True |
Akcje
| Aktualizowanie adresu urządzenia |
Zastępuje adres urządzenia. |
| Aktualizowanie nazwy urządzenia i notatek |
Zastępuje nazwę urządzenia, wewnętrzny identyfikator i uwagi partnera. |
| Aktualizowanie powiadomień dotyczących urządzeń |
Ustawia poziomy wypełnienia, na których są wysyłane powiadomienia o informacjach i alertach. |
| Aktualizowanie produktu |
Zastępuje wszystkie pola produktu. |
| Aktualizowanie użytkownika |
Zastępuje wszystkie pola klienta końcowego; pola pozostawione puste są czyszczone. |
| Aktualizowanie wewnętrznego identyfikatora partnera |
Zmienia wewnętrzny identyfikator partnera. |
| Anulowanie kontraktu urządzenia |
Oznacza kontrakt urządzenia na anulowanie w danej dacie. |
| Anulowanie przypisania urządzenia od użytkownika |
Usuwa urządzenie z klienta końcowego. Bez utrzymywania ustawień urządzenia adres urządzenia i ustawienia zbiornika są usuwane. |
| Blokowanie lub odblokowywanie urządzenia |
Blokuje lub odblokuje konfigurację urządzenia dla klientów końcowych. |
| Lista partnerów |
Zwraca partnera, który jest właścicielem poświadczeń połączenia i wszystkich swoich partnerów podrzędnych jako listy płaskiej, gotowej do zastosowania do każdego z nich. |
| Pobieranie drzewa partnerów |
Zwraca partnera, który jest właścicielem poświadczeń połączenia wraz ze wszystkimi jego partnerami podrzędnymi jako zagnieżdżonym drzewem. Użyj polecenia "Lista partnerów", aby utworzyć pętlę dla partnerów w przepływie. |
| Pobieranie stanu anulowania urządzenia |
Zwraca, czy umowa urządzenia została anulowana, czy oznaczona do anulowania oraz od momentu jego anulowania. |
| Pobieranie typów produktów |
Zwraca wszystkie typy produktów z ich ustawieniami domyślnymi. |
| Pobieranie urządzeń partnerskich |
Zwraca urządzenia należące bezpośrednio do jednego partnera z bieżącym poziomem wypełnienia i najnowszym pomiarem. Urządzenia podrzędnych partnerów nie są uwzględniane. |
| Pobieranie urządzeń użytkowników |
Zwraca urządzenia przypisane do jednego klienta końcowego z bieżącym poziomem wypełnienia i najnowszym pomiarem. |
| Pobieranie użytkownika |
Zwraca jednego klienta końcowego. |
| Pobieranie użytkownika pocztą e-mail |
Zwraca klienta końcowego z podanym adresem e-mail. |
| Pobieranie wstępnie zdefiniowanych typów zbiorników |
Zwraca typy zbiorników katalogowych dostępnych dla produktu. |
| Pobierz urządzenie |
Zwraca jedno urządzenie według identyfikatora sprzętu z bieżącym poziomem wypełnienia i najnowszym pomiarem. |
| Przenoszenie urządzenia do partnera |
Przenosi urządzenie do innego partnera w drzewie dostępnych partnerów. |
| Przypisywanie urządzenia do użytkownika |
Przypisuje urządzenie do klienta końcowego. |
| Tworzenie partnera |
Tworzy partnera podrzędnego. Nie można bezpiecznie ponowić próby: powtarzające się wywołanie powoduje utworzenie drugiego partnera. |
| Tworzenie produktu |
Tworzy produkt. Nie można bezpiecznie ponowić próby: powtarzające się wywołanie powoduje utworzenie drugiego produktu. |
| Ustaw silos |
Konfiguruje urządzenie dla silosu; zastępuje poprzednią konfigurację zbiornika lub silosu. |
| Ustawianie etykiet urządzeń |
Zastępuje wszystkie etykiety urządzenia daną listą; etykiety, które nie znajdują się na liście, są usuwane. |
| Ustawianie produktów partnerskich |
Zastępuje listę produktów przypisanych do partnera. |
| Ustawianie wiadomości e-mail z powiadomieniem partnera |
Zastępuje listę adresów e-mail, które odbierają powiadomienia partnera. |
| Ustawianie zbiornika niestandardowego |
Konfiguruje urządzenie dla zbiornika opisanego przez jego wymiary; zastępuje poprzednią konfigurację zbiornika lub silosu. |
| Usuwanie konfiguracji zbiornika |
Usuwa konfigurację zbiornika lub silosu urządzenia; poziomy wypełnienia nie są obliczane, dopóki nie zostanie ustawiona nowa konfiguracja. |
| Utwórz użytkownika |
Tworzy klienta końcowego. Nie można bezpiecznie ponowić próby: powtarzające się wywołanie kończy się niepowodzeniem lub tworzy duplikat. |
| Uzyskiwanie partnera |
Zwraca jednego partnera z wewnętrznym identyfikatorem, produktami i adresami e-mail powiadomień. |
| Wyszukiwanie partnerów według identyfikatora wewnętrznego |
Zwraca partnerów z danym identyfikatorem wewnętrznym. |
| Wyszukiwanie produktów według kodu |
Zwraca produkty z podanym kodem produktu. |
| Wyszukiwanie urządzeń według firmy |
Zwraca urządzenia, których adres firmy odpowiada podanej nazwie. |
| Wyszukiwanie urządzeń według identyfikatora wewnętrznego |
Zwraca urządzenia z danym identyfikatorem wewnętrznym specyficznym dla partnera. |
| Wyszukiwanie użytkowników według identyfikatora wewnętrznego |
Zwraca klientów końcowych z danym identyfikatorem wewnętrznym. |
| Wyszukiwanie użytkowników według pola niestandardowego |
Zwraca klientów końcowych, których pole niestandardowe ma daną wartość. |
| Zestaw zbiornika katalogowego |
Konfiguruje urządzenie dla typu zbiornika katalogowego (zobacz "Uzyskiwanie wstępnie zdefiniowanych typów zbiorników"). zastępuje poprzednią konfigurację zbiornika lub silosu. |
| Zmienianie nazwy partnera |
Zmienia nazwę partnera. |
| Zmienianie produktu urządzenia |
Zmienia produkt przechowywany w zbiorniku lub silosie urządzenia. |
Aktualizowanie adresu urządzenia
Zastępuje adres urządzenia.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Firma
|
company | True | string |
Firma; może być pusty. |
|
Ulica
|
streetLines | True | string |
Numer ulicy i domu. |
|
Kod pocztowy
|
zipCode | True | string |
Kod pocztowy. |
|
Miejscowość
|
city | True | string |
Miasto. |
|
Country
|
country | True | string |
Kraj jako kod ISO 3166-1 alfa-2. |
Zwraca
- Body
- Device
Aktualizowanie nazwy urządzenia i notatek
Zastępuje nazwę urządzenia, wewnętrzny identyfikator i uwagi partnera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Nazwa urządzenia
|
name | string |
Nazwa urządzenia; pozostaw puste, aby wyczyścić. |
|
|
Identyfikator wewnętrzny
|
internalId | True | string |
Własny identyfikator partnera dla urządzenia; pusty ciąg czyści go. |
|
Uwagi partnerów
|
partnerNotes | True | string |
Uwagi partnerów; pusty ciąg czyści je. |
Zwraca
- Body
- Device
Aktualizowanie powiadomień dotyczących urządzeń
Ustawia poziomy wypełnienia, na których są wysyłane powiadomienia o informacjach i alertach.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Powiadomienie o informacjach włączone
|
notificationInfoEnabled | True | boolean | |
|
Poziom powiadomień o informacjach (procent)
|
notificationInfoPercentage | True | integer |
Poziom wypełnienia w procentach (0–100), który wyzwala powiadomienie o informacjach. |
|
Powiadomienie o alertach włączone
|
notificationAlertEnabled | True | boolean | |
|
Poziom powiadomień o alertach (procent)
|
notificationAlertPercentage | True | integer |
Poziom wypełnienia w procentach (0–100), który wyzwala powiadomienie o alercie. |
Zwraca
- Body
- Device
Aktualizowanie produktu
Zastępuje wszystkie pola produktu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator produktu
|
productId | True | string |
Identyfikator produktu. |
|
Nazwa produktu
|
name | True | string | |
|
Kod produktu
|
code | True | string | |
|
Typ produktu
|
type | True | string | |
|
Gęstość (kg na L)
|
densityKgpl | double | ||
|
Adres URL obrazu
|
imageUrl | True | string |
Adres URL obrazu; pobierz je z "Pobierz typy produktów". |
|
Interwał pomiaru
|
measurementInterval | True | integer |
Ustaw wartość domyślną z "Pobierz typy produktów". |
|
Margines bezpieczeństwa
|
safetyMargin | True | double |
Ustaw wartość domyślną z "Pobierz typy produktów". |
|
Podstawa 100 procent
|
displayAs100Percent | True | string | |
|
Identyfikatory partnerów
|
partnerIds | True | array of string |
Partnerzy, do których jest przypisany produkt. |
|
Powiadomienie w trybie offline włączone
|
enabled | boolean | ||
|
Pierwsza liczba powiadomień w trybie offline
|
countFirst | integer | ||
|
Liczba sekund powiadomień w trybie offline
|
countSecond | integer | ||
|
Liczba cyklicznych powiadomień w trybie offline
|
countRecurring | integer | ||
|
Godzina pomiaru
|
hour | integer | ||
|
Minuta pomiaru
|
minute | integer |
Zwraca
- Body
- Product
Aktualizowanie użytkownika
Zastępuje wszystkie pola klienta końcowego; pola pozostawione puste są czyszczone.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Identyfikator klienta końcowego. |
|
Email
|
True | string | ||
|
Imię
|
firstName | True | string | |
|
Nazwisko
|
lastName | True | string | |
|
Title
|
title | string | ||
|
Phone
|
phone | string | ||
|
Nazwa firmy
|
companyName | True | string |
Nazwa firmy; może być pusty. |
|
Stanowisko firmy
|
companyPosition | string | ||
|
Ulica
|
street | string | ||
|
Kod pocztowy
|
zipCode | string | ||
|
Miejscowość
|
city | string | ||
|
Country
|
country | True | string |
Kraj jako kod ISO 3166-1 alfa-2. |
|
Locale
|
locale | True | string |
Język i region, np. de-DE. |
|
Role
|
role | True | string |
UŻYTKOWNIK dla klientów prywatnych, B2B_CUSTOMER/B2B_ADMIN dla klientów biznesowych. |
|
Wewnętrzny identyfikator użytkownika
|
internalId | string | ||
|
Partner użytkowników
|
partnerId | string |
Partner, do którego należy użytkownik. |
|
|
Pola niestandardowe
|
customFields | True | object |
Pola niestandardowe jako obiekt JSON par nazwa/wartość; użyj {} dla braków. |
Zwraca
- Body
- User
Aktualizowanie wewnętrznego identyfikatora partnera
Zmienia wewnętrzny identyfikator partnera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Partner
|
partnerId | True | string |
Partner do zmiany. |
|
Nowy identyfikator wewnętrzny partnera
|
internalId | True | string |
Zwraca
- Body
- Partner
Anulowanie kontraktu urządzenia
Oznacza kontrakt urządzenia na anulowanie w danej dacie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Anulowanie w roku
|
year | True | integer | |
|
Anuluj w miesiącu
|
month | True | integer | |
|
Anuluj w dniu
|
day | True | integer |
Zwraca
- Body
- CancelDeviceRequest
Anulowanie przypisania urządzenia od użytkownika
Usuwa urządzenie z klienta końcowego. Bez utrzymywania ustawień urządzenia adres urządzenia i ustawienia zbiornika są usuwane.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Identyfikator klienta końcowego. |
|
Identyfikator sprzętu
|
hwid | True | string | |
|
Zachowaj ustawienia urządzenia
|
keepData | boolean |
Tak, aby zachować ustawienia adresu i zbiornika urządzenia; wartość domyślna nie powoduje usunięcia ich. |
Zwraca
- Body
- Device
Blokowanie lub odblokowywanie urządzenia
Blokuje lub odblokuje konfigurację urządzenia dla klientów końcowych.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Zablokowany
|
isLocked | True | boolean |
Tak, aby zablokować konfigurację dla klientów końcowych. |
Zwraca
- Body
- Device
Lista partnerów
Zwraca partnera, który jest właścicielem poświadczeń połączenia i wszystkich swoich partnerów podrzędnych jako listy płaskiej, gotowej do zastosowania do każdego z nich.
Zwraca
- response
- array of PartnerListItem
Pobieranie drzewa partnerów
Zwraca partnera, który jest właścicielem poświadczeń połączenia wraz ze wszystkimi jego partnerami podrzędnymi jako zagnieżdżonym drzewem. Użyj polecenia "Lista partnerów", aby utworzyć pętlę dla partnerów w przepływie.
Zwraca
- Body
- PartnerTree
Pobieranie stanu anulowania urządzenia
Zwraca, czy umowa urządzenia została anulowana, czy oznaczona do anulowania oraz od momentu jego anulowania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia. |
Zwraca
- Body
- CancellationState
Pobieranie typów produktów
Pobieranie urządzeń partnerskich
Zwraca urządzenia należące bezpośrednio do jednego partnera z bieżącym poziomem wypełnienia i najnowszym pomiarem. Urządzenia podrzędnych partnerów nie są uwzględniane.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Partner
|
partnerId | True | string |
Partner, którego są zwracane własne urządzenia. |
Zwraca
- response
- array of Device
Pobieranie urządzeń użytkowników
Zwraca urządzenia przypisane do jednego klienta końcowego z bieżącym poziomem wypełnienia i najnowszym pomiarem.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Identyfikator klienta końcowego. |
Zwraca
- response
- array of Device
Pobieranie użytkownika
Zwraca jednego klienta końcowego.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Identyfikator klienta końcowego. |
Zwraca
- Body
- User
Pobieranie użytkownika pocztą e-mail
Zwraca klienta końcowego z podanym adresem e-mail.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Email
|
True | string |
Adres e-mail klienta końcowego. |
Zwraca
- Body
- User
Pobieranie wstępnie zdefiniowanych typów zbiorników
Zwraca typy zbiorników katalogowych dostępnych dla produktu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator produktu
|
productId | True | string |
Identyfikator produktu. |
Zwraca
- Body
- PredefinedTankTypes
Pobierz urządzenie
Zwraca jedno urządzenie według identyfikatora sprzętu z bieżącym poziomem wypełnienia i najnowszym pomiarem.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
Zwraca
- Body
- Device
Przenoszenie urządzenia do partnera
Przenosi urządzenie do innego partnera w drzewie dostępnych partnerów.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Partner docelowy
|
partnerId | True | string |
Partner do przeniesienia urządzenia do. |
Zwraca
- Body
- Device
Przypisywanie urządzenia do użytkownika
Przypisuje urządzenie do klienta końcowego.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Identyfikator klienta końcowego. |
|
Identyfikator sprzętu
|
hwid | True | string | |
|
Zachowaj ustawienia urządzenia
|
keepData | True | boolean |
Tak, aby zachować ustawienia adresu i zbiornika urządzenia. |
Zwraca
- Body
- Device
Tworzenie partnera
Tworzy partnera podrzędnego. Nie można bezpiecznie ponowić próby: powtarzające się wywołanie powoduje utworzenie drugiego partnera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa partnera
|
name | True | string | |
|
Wewnętrzny identyfikator partnera
|
internalId | string | ||
|
Partner nadrzędny
|
parentId | True | string |
Partner, w ramach którego jest tworzony nowy partner. |
|
Identyfikatory produktów
|
productIds | True | array of string |
Produkty przypisane do nowego partnera. |
Zwraca
- Body
- Partner
Tworzenie produktu
Tworzy produkt. Nie można bezpiecznie ponowić próby: powtarzające się wywołanie powoduje utworzenie drugiego produktu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa produktu
|
name | True | string | |
|
Kod produktu
|
code | True | string | |
|
Typ produktu
|
type | True | string | |
|
Gęstość (kg na L)
|
densityKgpl | double | ||
|
Adres URL obrazu
|
imageUrl | True | string |
Adres URL obrazu; pobierz je z "Pobierz typy produktów". |
|
Interwał pomiaru
|
measurementInterval | True | integer |
Ustaw wartość domyślną z "Pobierz typy produktów". |
|
Margines bezpieczeństwa
|
safetyMargin | True | double |
Ustaw wartość domyślną z "Pobierz typy produktów". |
|
Podstawa 100 procent
|
displayAs100Percent | True | string | |
|
Identyfikatory partnerów
|
partnerIds | True | array of string |
Partnerzy, do których jest przypisany produkt. |
|
Powiadomienie w trybie offline włączone
|
enabled | boolean | ||
|
Pierwsza liczba powiadomień w trybie offline
|
countFirst | integer | ||
|
Liczba sekund powiadomień w trybie offline
|
countSecond | integer | ||
|
Liczba cyklicznych powiadomień w trybie offline
|
countRecurring | integer | ||
|
Godzina pomiaru
|
hour | integer | ||
|
Minuta pomiaru
|
minute | integer |
Zwraca
- Body
- Product
Ustaw silos
Konfiguruje urządzenie dla silosu; zastępuje poprzednią konfigurację zbiornika lub silosu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Wysokość silosu (cm)
|
heightCm | True | double | |
|
Szerokość silosu (cm)
|
widthCm | True | double | |
|
Długość silosu (cm)
|
lengthCm | True | double | |
|
Przesunięcie górne silosu (cm)
|
offsetTopCm | True | double | |
|
Przesunięcie boczne silosu (cm)
|
offsetSideCm | True | double | |
|
Typ magazynu silosu
|
storeType | True | string | |
|
Montaż silosu
|
mounting | True | string | |
|
Pojemność silosu (kg)
|
massKg | True | integer | |
|
Identyfikator produktu
|
productId | True | string |
Identyfikator przechowywanego produktu. |
Zwraca
- Body
- Device
Ustawianie etykiet urządzeń
Zastępuje wszystkie etykiety urządzenia daną listą; etykiety, które nie znajdują się na liście, są usuwane.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Etykiety
|
labels | True | array of string |
Pełna lista etykiet; Zastępuje bieżące etykiety. |
Zwraca
- Body
- Device
Ustawianie produktów partnerskich
Zastępuje listę produktów przypisanych do partnera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Partner
|
partnerId | True | string |
Partner do zmiany. |
|
Identyfikatory produktów
|
productIds | True | array of string |
Pełna lista; zastępuje bieżące produkty. |
Zwraca
- Body
- Partner
Ustawianie wiadomości e-mail z powiadomieniem partnera
Zastępuje listę adresów e-mail, które odbierają powiadomienia partnera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Partner
|
partnerId | True | string |
Partner do zmiany. |
|
Wiadomości e-mail z powiadomieniami
|
notificationEmails | True | array of string |
Pełna lista; Zastępuje bieżące adresy. |
Zwraca
- Body
- Partner
Ustawianie zbiornika niestandardowego
Konfiguruje urządzenie dla zbiornika opisanego przez jego wymiary; zastępuje poprzednią konfigurację zbiornika lub silosu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Wysokość zbiornika (cm)
|
heightCm | True | double | |
|
Przesunięcie czujnika (cm)
|
offsetCm | True | double |
Odległość między czujnikiem a zbiornikiem u góry. |
|
Objętość zbiornika (L)
|
volumeL | True | integer | |
|
Wolumin jest woluminem do użycia
|
isUsableVolume | True | boolean |
Tak, jeśli wolumin jest woluminem do użytku, nie, jeśli jest to łączny wolumin. |
|
Kształt zbiornika
|
shape | True | string |
VERTICAL_CYLINDER jest przechowywany jako wysyłany, ale zgłaszany jako SQUARED. |
|
Typ instalowania
|
mountingType | True | string |
Jak jest zainstalowany czujnik. |
|
Identyfikator produktu
|
productId | True | string |
Identyfikator przechowywanego produktu. |
Zwraca
- Body
- Device
Usuwanie konfiguracji zbiornika
Usuwa konfigurację zbiornika lub silosu urządzenia; poziomy wypełnienia nie są obliczane, dopóki nie zostanie ustawiona nowa konfiguracja.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
Zwraca
- Body
- Device
Utwórz użytkownika
Tworzy klienta końcowego. Nie można bezpiecznie ponowić próby: powtarzające się wywołanie kończy się niepowodzeniem lub tworzy duplikat.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Email
|
True | string | ||
|
Imię
|
firstName | True | string | |
|
Nazwisko
|
lastName | True | string | |
|
Title
|
title | string | ||
|
Phone
|
phone | string | ||
|
Nazwa firmy
|
companyName | True | string |
Nazwa firmy; może być pusty. |
|
Stanowisko firmy
|
companyPosition | string | ||
|
Ulica
|
street | string | ||
|
Kod pocztowy
|
zipCode | string | ||
|
Miejscowość
|
city | string | ||
|
Country
|
country | True | string |
Kraj jako kod ISO 3166-1 alfa-2. |
|
Locale
|
locale | True | string |
Język i region, np. de-DE. |
|
Role
|
role | True | string |
UŻYTKOWNIK dla klientów prywatnych, B2B_CUSTOMER/B2B_ADMIN dla klientów biznesowych. |
|
Wewnętrzny identyfikator użytkownika
|
internalId | string | ||
|
Partner użytkowników
|
partnerId | string |
Partner, do którego należy użytkownik. |
|
|
Pola niestandardowe
|
customFields | True | object |
Pola niestandardowe jako obiekt JSON par nazwa/wartość; użyj {} dla braków. |
Zwraca
- Body
- User
Uzyskiwanie partnera
Zwraca jednego partnera z wewnętrznym identyfikatorem, produktami i adresami e-mail powiadomień.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Partner
|
partnerId | True | string |
Partner, który ma wrócić. |
Zwraca
- Body
- Partner
Wyszukiwanie partnerów według identyfikatora wewnętrznego
Zwraca partnerów z danym identyfikatorem wewnętrznym.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wewnętrzny
|
internalId | True | string |
Wewnętrzny identyfikator partnera. |
Zwraca
- response
- array of Partner
Wyszukiwanie produktów według kodu
Zwraca produkty z podanym kodem produktu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kod produktu
|
productCode | True | string |
Kod produktu. |
Zwraca
- response
- array of Product
Wyszukiwanie urządzeń według firmy
Zwraca urządzenia, których adres firmy odpowiada podanej nazwie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Firma
|
company | True | string |
Nazwa firmy w adresie urządzenia. |
Zwraca
- response
- array of Device
Wyszukiwanie urządzeń według identyfikatora wewnętrznego
Zwraca urządzenia z danym identyfikatorem wewnętrznym specyficznym dla partnera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wewnętrzny
|
internalId | True | string |
Własny identyfikator partnera dla urządzenia. |
Zwraca
- response
- array of Device
Wyszukiwanie użytkowników według identyfikatora wewnętrznego
Zwraca klientów końcowych z danym identyfikatorem wewnętrznym.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wewnętrzny
|
internalId | True | string |
Wewnętrzny identyfikator klienta końcowego. |
Zwraca
- response
- array of User
Wyszukiwanie użytkowników według pola niestandardowego
Zwraca klientów końcowych, których pole niestandardowe ma daną wartość.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa pola niestandardowego
|
fieldName | True | string |
Nazwa pola niestandardowego. |
|
Wartość pola niestandardowego
|
fieldValue | True | string |
Wartość do wyszukania. |
Zwraca
- response
- array of User
Zestaw zbiornika katalogowego
Konfiguruje urządzenie dla typu zbiornika katalogowego (zobacz "Uzyskiwanie wstępnie zdefiniowanych typów zbiorników"). zastępuje poprzednią konfigurację zbiornika lub silosu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Identyfikator typu zbiornika
|
storageTypeId | True | string |
Identyfikator typu zbiornika katalogowego z "Pobierz wstępnie zdefiniowane typy zbiorników". |
|
Liczba zbiorników
|
storageCount | True | integer |
Liczba połączonych zbiorników tego typu. |
|
Przesunięcie czujnika (cm)
|
offsetTopCm | True | double | |
|
Typ instalowania
|
mountingType | True | string |
Jak jest zainstalowany czujnik. |
|
Identyfikator produktu
|
productId | True | string |
Identyfikator przechowywanego produktu. |
Zwraca
- Body
- Device
Zmienianie nazwy partnera
Zmienia nazwę partnera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Partner
|
partnerId | True | string |
Partner do zmiany. |
|
Nazwa nowego partnera
|
name | True | string |
Zwraca
- Body
- Partner
Zmienianie produktu urządzenia
Zmienia produkt przechowywany w zbiorniku lub silosie urządzenia.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | True | string |
Identyfikator sprzętu urządzenia wydrukowany na czujniku. |
|
Identyfikator produktu
|
productId | True | string |
Identyfikator nowego produktu. |
Zwraca
- Body
- Device
Definicje
Partner
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator partnera
|
id | uuid |
Identyfikator partnera. |
|
Wewnętrzny identyfikator partnera
|
internalId | string |
Wewnętrzny identyfikator partnera. |
|
Nazwa partnera
|
name | string |
Nazwa partnera. |
|
Products
|
products | array of PartnerProduct |
Produkty przypisane do partnera. |
|
Wiadomości e-mail z powiadomieniami
|
notificationEmails | array of string |
Adresy e-mail odbierające powiadomienia partnera. |
User
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator użytkownika
|
id | uuid |
Identyfikator użytkownika. |
|
Wewnętrzny identyfikator użytkownika
|
internalId | string |
Własny identyfikator partnera dla klienta końcowego. |
|
Identyfikator partnera użytkowników
|
partnerId | uuid |
Identyfikator partnera, do którego należy użytkownik. |
|
Email
|
string |
Adres e-mail. |
|
|
Phone
|
phone | string |
Numer telefonu. |
|
Title
|
title | string |
Tytuł. |
|
Imię
|
firstName | string |
Imię. |
|
Nazwisko
|
lastName | string |
Nazwisko. |
|
Nazwa firmy
|
companyName | string |
Nazwa firmy. |
|
Stanowisko firmy
|
companyPosition | string |
Stanowisko w firmie, np. ZARZĄDZANIE, SPRZEDAŻ, WYSYŁKA. |
|
Ulica
|
street | string |
Numer ulicy i domu. |
|
Kod pocztowy
|
zipCode | string |
Kod pocztowy. |
|
Miejscowość
|
city | string |
Miasto. |
|
Country
|
country | string |
Kraj jako kod ISO 3166-1 alfa-2. |
|
Locale
|
locale | string |
Język i region, np. de-DE. |
|
Role
|
role | string |
Rola, np. USER, B2B_CUSTOMER, B2B_ADMIN. |
|
Pola niestandardowe
|
customFields | object |
Pola niestandardowe zdefiniowane przez partnera są parami nazwa/wartość. |
Produkt
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator produktu
|
id | uuid |
Identyfikator produktu. |
|
Nazwa produktu
|
name | string |
Nazwa produktu. |
|
Kod produktu
|
code | string |
Kod produktu. |
|
Typ produktu
|
type | string |
Typ produktu, np. HEATING_OIL, DIESEL, LPG, PELETY. |
|
Zbiera
|
isCollecting | boolean |
Czy produkt jest zbierany (np. olej odpadowy) zamiast spożywany. |
|
Gęstość (kg na L)
|
densityKgpl | double |
Gęstość w kg na litr. |
|
Interwał pomiaru
|
measurementInterval | integer |
Interwał pomiaru. |
|
Podstawa 100 procent
|
displayAs100Percent | string |
Która pojemność liczy się jako 100 procent: USABLE_VOLUME lub TOTAL_VOLUME. |
|
Margines bezpieczeństwa
|
safetyMargin | double |
Margines bezpieczeństwa. |
|
Adres URL obrazu
|
imageUrl | string |
Adres URL obrazu produktu. |
|
Identyfikatory partnerów
|
partnerIds | array of uuid |
Partnerzy, do których jest przypisany produkt. |
|
Powiadomienie w trybie offline włączone
|
offlineNotification.enabled | boolean | |
|
Pierwsza liczba powiadomień w trybie offline
|
offlineNotification.countFirst | integer | |
|
Liczba sekund powiadomień w trybie offline
|
offlineNotification.countSecond | integer | |
|
Liczba cyklicznych powiadomień w trybie offline
|
offlineNotification.countRecurring | integer | |
|
Domyślny indeks jakości
|
qualityList.defaultIndex | integer | |
|
domyślny
|
qualityList.default | ProductQuality | |
|
Właściwości
|
qualityList.items | array of ProductQuality | |
|
Godzina pomiaru
|
meteringTime.hour | integer | |
|
Minuta pomiaru
|
meteringTime.minute | integer | |
|
Sekunda pomiaru
|
meteringTime.second | integer | |
|
Pomiar nanosekund
|
meteringTime.nano | integer |
ProductQuality
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator jakości
|
id | uuid | |
|
Nazwa jakości
|
name | string | |
|
Kod jakości
|
code | string |
Typ Produktu
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ produktu
|
type | string |
Typ produktu, np. HEATING_OIL, DIESEL, LPG, PELETY. |
|
Gęstość domyślna (kg na L)
|
defaultDensityKgpl | double |
Domyślna gęstość w kg na litr. |
|
Domyślny interwał pomiaru
|
measurementInterval | integer | |
|
Domyślny margines bezpieczeństwa
|
safetyMargin | double | |
|
Domyślna podstawa 100 procent
|
displayAs100Percent | string |
USABLE_VOLUME lub TOTAL_VOLUME. |
|
Adres URL obrazu
|
imageUrl | string |
PredefinedTankTypes
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typy zbiorników
|
types | array of TankPredefinedType |
Typy zbiorników katalogowych. |
CancellationState
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | string |
Identyfikator sprzętu urządzenia. |
|
Anulowano
|
isCancelled | boolean |
Czy umowa urządzenia została anulowana. |
|
Anulowanie po roku
|
cancellableAfter.year | integer | |
|
Anulowanie po miesiącu
|
cancellableAfter.month | integer | |
|
Anulowanie można anulować po dniu
|
cancellableAfter.day | integer | |
|
Rok anulowania
|
markedForCancellationOn.year | integer | |
|
Miesiąc anulowania
|
markedForCancellationOn.month | integer | |
|
Dzień anulowania
|
markedForCancellationOn.day | integer |
CancelDeviceRequest
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Anulowanie w roku
|
cancelAt.year | integer | |
|
Anuluj w miesiącu
|
cancelAt.month | integer | |
|
Anuluj w dniu
|
cancelAt.day | integer |
PartnerTree
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator partnera
|
id | uuid |
Identyfikator partnera. |
|
Nazwa partnera
|
name | string |
Nazwa partnera. |
|
Products
|
products | array of PartnerProduct |
Produkty przypisane do partnera. |
|
Podpartnery
|
children | array of object |
Partnerzy podrzędni, każdy z tą samą strukturą co partner. |
|
items
|
children | object |
PartnerListItem
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator partnera
|
id | uuid |
Identyfikator partnera. |
|
Nazwa partnera
|
name | string |
Nazwa partnera. |
|
Identyfikator partnera nadrzędnego
|
parentId | uuid |
Identyfikator partnera nadrzędnego; pusty dla partnera, który jest właścicielem poświadczeń. |
|
Głębokość
|
depth | integer |
Poziom w drzewie partnera; 0 dla partnera, który jest właścicielem poświadczeń. |
|
Products
|
products | array of PartnerProduct |
Produkty przypisane do partnera. |
PartnerProduct
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator produktu
|
id | uuid |
Identyfikator produktu. |
|
Nazwa produktu
|
name | string |
Nazwa produktu. |
|
Kod produktu
|
code | string |
Kod produktu. |
|
Typ produktu
|
type | string |
Typ produktu, np. HEATING_OIL. |
Device
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator sprzętu
|
hwid | string |
Identyfikator sprzętu urządzenia; stabilny klucz dla urządzenia. |
|
Nazwa urządzenia
|
name | string |
Nazwa urządzenia. |
|
identyfikator partnera
|
partnerId | uuid |
Identyfikator partnera, do którego należy urządzenie. |
|
Identyfikator wewnętrzny
|
internalId | string |
Własny identyfikator partnera dla urządzenia; może być pusty i nie ma gwarancji, że jest unikatowy. |
|
Uwagi partnerów
|
partnerNotes | string |
Uwagi partnerów. |
|
Identyfikator produktu
|
productId | uuid |
Identyfikator przechowywanego produktu. |
|
Kod produktu
|
productCode | string |
Kod przechowywanego produktu. |
|
Identyfikator użytkownika
|
userId | uuid |
Identyfikator klienta końcowego, do któremu jest przypisane urządzenie. |
|
Ma umowę serwisową
|
hasServiceAgreement | boolean |
Czy klient końcowy ma umowę serwisową. |
|
Stan konserwacji
|
maintenanceState | string |
Stan konserwacji: NIEZNANY, OK, SKARŻYŁ SIĘ, SENT_BACK, ODEBRANO, SPRAWDZONO lub WADĘ. |
|
adres
|
address | Address | |
|
Maksymalny wolumin (starsza wersja)
|
maxVolume | integer |
Starsza maksymalna objętość w litrach; Zamiast tego użyj wartości Usable Quantity/Total Quantity. |
|
lastMetering
|
lastMetering | Metering |
Najnowszy niezawodny pomiar; puste, gdy urządzenie nie zostało jeszcze zmierzone. |
|
Powiadomienie o informacjach włączone
|
notificationInfoEnabled | boolean |
Czy powiadomienie o informacjach jest włączone. |
|
Poziom powiadomień o informacjach (procent)
|
notificationInfoPercentage | integer |
Poziom wypełnienia w procentach, który wyzwala powiadomienie o informacjach. |
|
Powiadomienie o alertach włączone
|
notificationAlertEnabled | boolean |
Określa, czy powiadomienie o alercie jest włączone. |
|
Poziom powiadomień o alertach (procent)
|
notificationAlertPercentage | integer |
Poziom wypełnienia w procentach, który wyzwala powiadomienie o alercie. |
|
Jest zablokowany
|
isLocked | boolean |
Czy konfiguracja urządzenia jest zablokowana. |
|
obliczone
|
computed | ComputedStorage |
Poziom wypełnienia obliczony z konfiguracji magazynu; puste, gdy urządzenie nie ma skonfigurowanego magazynu. |
|
tankCustom
|
tankCustom | TankCustom |
Niestandardowa konfiguracja zbiornika. |
|
silos
|
silo | Silo |
Konfiguracja silosu. |
|
tankPredefined
|
tankPredefined | TankPredefined |
Wstępnie zdefiniowana (katalogowa) konfiguracja zbiornika. |
|
salesAssistantPrediction
|
salesAssistantPrediction | SalesPrediction |
Przewidywanie zamówień asystenta sprzedaży. |
|
Etykiety
|
labels | array of string |
Etykiety przypisane do urządzenia. |
Address
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Adres firmy
|
company | string |
Firmy. |
|
Ulica adresowa
|
streetLines | string |
Numer ulicy i domu. |
|
Miasto adresowe
|
city | string |
Miasto. |
|
Adresowy kod pocztowy
|
zipCode | string |
Kod pocztowy. |
|
Adres kraju
|
country | string |
Kraj jako kod ISO 3166-1 alfa-2. |
Pomiar
Najnowszy niezawodny pomiar; puste, gdy urządzenie nie zostało jeszcze zmierzone.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Mierzona ilość (L)
|
quantity | integer |
Mierzona ilość w litrach. |
|
Mierzona jednostka ilości
|
quantityUnit | string |
Jednostka mierzonej ilości. |
|
Mierzone w czasie (w sekundach systemu Unix)
|
timestamp | integer |
Czas pomiaru jako sekundy systemu Unix. |
|
Mierzone w
|
measuredAt | date-time |
Czas pomiaru w formacie UTC pochodzący z sygnatury czasowej systemu Unix najnowszej miary. |
|
estimatedForecastDate
|
estimatedForecastDate | LocalDate |
Szacowana data, kiedy magazyn wymaga ponownego wypełniania. |
|
Poziom naładowania baterii
|
batteryLevel | string |
Poziom baterii: PEŁNY, DOBRY, ŚREDNI, OSTRZEGAWCZY LUB KRYTYCZNY. |
|
Siła sygnału
|
signalStrength | string |
Siła sygnału: VERY_WEAK, SŁABE, DOBRE lub DOSKONAŁE. |
|
Odległość nieprzetworzona (cm)
|
distanceCm | double |
Nieprzetworzona mierzona odległość w cm. |
|
Surowe ciśnienie (Pa)
|
pressurePa | double |
Surowe mierzone ciśnienie w Pa. |
|
Kąt pierwotny (odg)
|
angleDeg | double |
Nieprzetworzone mierzone kąty w stopniach. |
ComputedStorage
Poziom wypełnienia obliczony z konfiguracji magazynu; puste, gdy urządzenie nie ma skonfigurowanego magazynu.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
currentQuantity
|
currentQuantity | Quantity | |
|
Poziom wypełnienia (procent)
|
percentage | integer |
Poziom wypełnienia w procentach; sprawdź mierzone w, urządzenie bez pomiaru może zgłosić 0. |
|
usableQuantity
|
usableQuantity | Quantity | |
|
totalQuantity
|
totalQuantity | Quantity | |
|
Margines bezpieczeństwa produktu
|
productSafetyMargin | double |
Margines bezpieczeństwa produktu. |
|
Podstawa 100 procent
|
displayAs100Percent | string |
Która pojemność liczy się jako 100 procent: USABLE_VOLUME lub TOTAL_VOLUME. |
|
Nazwa produktu
|
productName | string |
Przechowywany produkt. |
|
Zbiera produkt
|
isCollectingProduct | boolean |
Czy magazyn zbiera produkt (np. olej odpadowy) zamiast go spożywać. |
Ilość
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Value
|
value | integer |
Ilość. |
|
Jednostka
|
unit | string |
Jednostka: L lub kg. |
Dane lokalne
Szacowana data, kiedy magazyn wymaga ponownego wypełniania.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Rok prognozy
|
year | integer | |
|
Miesiąc prognozy
|
month | integer | |
|
Dzień prognozy
|
day | integer |
SalesPrediction
Przewidywanie zamówień asystenta sprzedaży.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Prawdopodobieństwo zamówienia (nieprzetworzone)
|
indexRaw | double |
Nieprzetworzone indeksy prawdopodobieństwa zamówień. |
|
Prawdopodobieństwo zamówienia
|
index | string |
Prawdopodobieństwo zamówienia: VERY_HIGH, WYSOKI, ŚREDNI lub NISKI. |
|
ilość
|
quantity | Quantity |
TankCustom
Niestandardowa konfiguracja zbiornika.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wysokość zbiornika (cm)
|
heightCm | double | |
|
Przesunięcie czujnika (cm)
|
offsetCm | double | |
|
Objętość zbiornika (L)
|
volumeL | integer | |
|
Wolumin do wykorzystania (L)
|
usableVolumeL | integer | |
|
Wolumin jest woluminem do użycia
|
isUsableVolume | boolean | |
|
Kształt zbiornika
|
shape | string |
KWADRATY, ZAOKRĄGLONE LUB WALCOWE. |
|
Typ instalowania
|
mountingType | string |
KLEJ LUB ŚRUBA. |
|
Identyfikator produktu zbiornika
|
productId | uuid |
TankPredefined
Wstępnie zdefiniowana (katalogowa) konfiguracja zbiornika.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przesunięcie czujnika (cm)
|
offsetTopCm | double | |
|
Liczba zbiorników
|
storageCount | integer | |
|
Typ instalowania
|
mountingType | string |
KLEJ LUB ŚRUBA. |
|
Identyfikator produktu zbiornika
|
productId | uuid | |
|
typ
|
type | TankPredefinedType |
TankPredefinedType
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator typu zbiornika
|
id | uuid | |
|
Producent zbiornika
|
manufacturerName | string | |
|
Typ zbiornika
|
typeName | string | |
|
Wysokość zbiornika (cm)
|
totalHeightCm | double | |
|
Przesunięcie górne (cm)
|
offsetTopInternalCm | double | |
|
Przesunięcie dna typu zbiornika (cm)
|
offsetBottomCm | double | |
|
totalQuantity
|
totalQuantity | Quantity |
Silos
Konfiguracja silosu.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wysokość silosu (cm)
|
heightCm | double | |
|
Szerokość silosu (cm)
|
widthCm | double | |
|
Długość silosu (cm)
|
lengthCm | double | |
|
Przesunięcie górne silosu (cm)
|
offsetTopCm | double | |
|
Przesunięcie boczne silosu (cm)
|
offsetSideCm | double | |
|
Typ magazynu silosu
|
storeType | string |
SACK_SILO, BUNKER_CONVEYOR lub BUNKER_PROBE. |
|
Montaż silosu
|
mounting | string |
CEILING_VERTICAL, CEILING_DIAGONAL, PIPE_DIAGONAL lub PIPE_VERTICAL. |
|
Pojemność silosu (kg)
|
massKg | integer | |
|
Identyfikator produktu silosu
|
productId | uuid |