Staffbase (wersja zapoznawcza)
Łącznik Staffbase connector umożliwia łączenie różnych narzędzi i systemów oraz integrowanie platformy Staffbase z zautomatyzowanymi przepływami pracy. Obejmuje to aplikację pracownika lub intranet do automatyzowania procesów, uruchamiania zadań zgodnie z harmonogramem lub powiadamiania użytkowników o wystąpieniu zdarzeń.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | 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) |
| Kontakt | |
|---|---|
| Name | Pomoc techniczna dla personelu w bazie danych |
| adres URL | https://www.staffbase.com |
| support@staffbase.com |
| Metadane łącznika | |
|---|---|
| Publisher | Staffbase GmbH |
| Witryna internetowa | https://www.staffbase.com |
| Zasady ochrony prywatności | https://staffbase.com/en/privacy-policy/ |
| Kategorie | Komunikacja; Zasoby ludzkie |
Łącznik staffbase
Łącznik Staffbase dla usługi Power Automate pozwala wypełnić lukę między różnymi narzędziami i systemami oraz uwzględnić platformę Staffbase w zautomatyzowanych przepływach pracy. Korzystaj z możliwości zautomatyzowanych przepływów pracy, które obejmują aplikację pracownika lub intranet, aby automatyzować procesy, uruchamiać zadania zgodnie z harmonogramem lub powiadamiać użytkowników o zdarzeniach.
Wymagania wstępne
- Plan usługi Microsoft Power Apps lub Power Automate z funkcją łącznika niestandardowego
- Licencja staffbase dla organizacji
- Rola administratora organizacji na platformie Staffbase
- Token interfejsu API do konfigurowania uwierzytelniania
- Informacje na temat infrastruktury staffasbe hostowanej w aplikacji, skontaktuj się, aby support@staffbase.com uzyskać więcej informacji
Obsługiwane operacje
Lista kanałówPobierz
Pobieranie listy kanałów aktualności
ChannelGetPosts
Pobieranie listy wpisów w określonym kanale
ChannelPostPost
Wysyłanie wpisu do określonego kanału
KomentarzePobierz
Pobieranie wszystkich komentarzy z wystąpienia staffbase
MediaGet
Pobieranie wszystkich multimediów z wystąpienia usługi Staffbase
Identyfikator MediaGetByID
Pobieranie multimediów według identyfikatora
MediaDelete
Usuwanie nośnika według identyfikatora
NotificationPost
Wysyła powiadomienie do użytkowników
PostsGetAll
Pobieranie listy wpisów
PostsGetByID
Pobieranie wpisu według identyfikatora
PostYUsuń
Usuwa wpis
PostPut
Aktualizuje wpis
UserGetAll
Pobieranie listy użytkowników
UserPost
Zaproś użytkownika według imię, nazwisko i wiadomość e-mail
UserGetByID
Uzyskiwanie informacji o użytkowniku
User_delete
Usuwanie użytkownika według identyfikatora
UserPut
Aktualizowanie informacji o użytkowniku
UserPostRecovery
Wysyłanie wiadomości e-mail z odzyskiwaniem
ProxyVersionGet
Tylko w przypadku użycia wewnętrznego, aby sprawdzić bieżącą wersję serwera proxy interfejsu API
Uzyskiwanie poświadczeń
Aby uzyskać podstawowe uwierzytelnianie między platformą Staffbase i przepływem pracy utworzonym w usłudze Power Automate, potrzebujesz tokenu interfejsu API. Token interfejsu API można wygenerować z poziomu programu Staffbase Experience Studio.
Wprowadzenie
Skonfiguruj łącznik przy użyciu uwierzytelniania podstawowego i adresu URL hostingu.
- W usłudze Power Automate przejdź do pozycji Łączniki.
- Wyszukaj łącznik Staffbase.
- Kliknij łącznik Staffbase. Zostanie otwarte okno dialogowe konfigurowania łącznika.
- W polu Token interfejsu API dodaj token interfejsu API przy użyciu następującej składni: Podstawowa [API-Token]
Uwaga: musisz dodać puste miejsce między wartością "Podstawowa" i tokenem interfejsu API.
W polu Identyfikator hosta wprowadź identyfikator infrastruktury, w której jest hostowana platforma Staffbase:
- Niemiecka infrastruktura: de1
- Infrastruktura międzynarodowa: us1
Aby uzyskać szczegółowe informacje, odwiedź portal pomocy technicznej staffbase.
Znane problemy i ograniczenia
Łącznik Staffbase obecnie nie obsługuje wszystkich funkcji interfejsu API Staffbase. Aby uzyskać bardziej szczegółowe informacje na temat interfejsów API staffbase, odwiedź portal dla deweloperów staffbase.
Często zadawane pytania
Jakie przepływy pracy biznesowe można zautomatyzować za pomocą łącznika Staffbase?
Wiele procesów biznesowych można zautomatyzować przy użyciu łącznika Staffbase. Na przykład powiadom pracowników bezpośrednio w aplikacji pracownika lub intranecie jako i po wystąpieniu akcji w innych narzędziach. Dowiedz się więcej na temat takich przypadków użycia biznesowego tutaj.
Czy istnieją samouczki ułatwiające rozpoczęcie pracy zautomatyzowanego przepływu pracy przy użyciu łącznika Staffbase?
Staffbase oferuje samouczki korzystające z naszej wtyczki Forms i łącznika Staffbase w celu zautomatyzowania zarządzania obiektami. Dowiedz się więcej o sposobie jej konfigurowania w tej sekcji.
Instrukcje dotyczące wdrażania
Uruchom następujące polecenia i postępuj zgodnie z monitami:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>
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ć |
Domyślny
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 | Description | Wymagane |
|---|---|---|---|
| API-Key | securestring | "API-Key" dla wystąpienia staffbase | Prawda |
| Identyfikator hostingu | ciąg | Określ identyfikator hostingu: hostingID | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Kanały: pobieranie listy kanałów aktualności |
Pobierz listę kanałów aktualności. |
| Kanały: pobieranie listy wpisów w określonym kanale |
Pobierz listę wpisów w określonym kanale. |
| Kanały: wysyłanie wpisu do określonego kanału |
Wyślij wpis do określonego kanału informacyjnego. |
| Multimedia: pobieranie multimediów według identyfikatora |
Pobieranie metadanych dla pojedynczego nośnika według jego identyfikatora. |
| Multimedia: Pobieranie wszystkich multimediów |
Żąda opisu wszystkich multimediów dostępnych w bieżącym kontekście. |
| Nośnik: usuwanie multimediów |
Usuwa określony nośnik w bieżącym kontekście. |
| Powiadomienie: wysyła powiadomienie |
Wysyła powiadomienia do określonych użytkowników. |
| Serwer proxy: Pobieranie wersji |
Zwraca bieżącą wersję serwera proxy. |
| Użytkownik: Aktualizowanie informacji o użytkowniku |
Aktualizowanie informacji o użytkowniku. |
| Użytkownik: pobieranie informacji o użytkowniku |
Uzyskaj określone informacje o użytkowniku według jego identyfikatora użytkownika. |
| Użytkownik: pobieranie listy użytkowników |
Pobierz listę użytkowników w zależności od tokenu dostępu interfejsu API. |
| Użytkownik: Usuwanie użytkownika |
Usuwa określonego użytkownika. |
| Użytkownik: wysyłanie wiadomości e-mail z odzyskiwaniem |
Wysyła wiadomość e-mail odzyskiwania do określonego użytkownika. |
| Użytkownik: Zapraszanie użytkownika |
Użytkownik otrzyma wiadomość e-mail z informacją o rejestracji. |
| Wpisy: aktualizuje wpis |
Aktualizuje wpis, tylko zmienione pole (przyrostowe). |
| Wpisy: Pobieranie komentarzy |
Pobierz listę komentarzy. |
| Wpisy: pobieranie listy wpisów |
Pobierz listę wpisów dostępnych dla tokenu interfejsu API. |
| Wpisy: pobieranie wpisu według identyfikatora |
Żąda określonych wpisów, w tym zestawu komentarzy. |
| Wpisy: usuwa wpis |
Usuwa wpis z systemu. |
Kanały: pobieranie listy kanałów aktualności
Pobierz listę kanałów aktualności.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
łączny
|
total | integer |
Łączna liczba znalezionych kanałów. |
|
limit
|
limit | integer |
Ilość zwracanych elementów. |
|
przesunąć
|
offset | integer |
Bieżące zdefiniowane przesunięcie pobierania elementów rozpoczynających się od tej liczby. |
|
dane
|
data | array of object | |
|
id
|
data.id | string |
Jest to identyfikator kanału. |
|
lokalizacja
|
data.config.localization | array of object | |
|
title
|
data.config.localization.title | string |
Tytuł kanału zlokalizowany. |
|
regionalny
|
data.config.localization.locale | string |
To jest ustawienia regionalne tytułu kanału. |
|
spaceID
|
data.spaceID | string |
Identyfikator miejsca, do którego jest przypisany kanał. |
|
utworzone
|
data.created | string |
Data utworzenia kanału. |
|
Opublikowany
|
data.published | string |
Data publikacji kanału. |
|
aktualizowano
|
data.updated | string |
Zaktualizowana data kanału. |
Kanały: pobieranie listy wpisów w określonym kanale
Pobierz listę wpisów w określonym kanale.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kanału
|
channelID | True | string |
Wstaw tutaj identyfikator kanału, np. pobrany przez polecenie getChannels. |
|
Ograniczenie
|
limit | integer |
Ilość elementów, które powinny zostać zwrócone (wartość domyślna i maksymalna 100). |
|
|
Przesunięcie
|
offset | integer |
Zdefiniuj przesunięcie pobierania elementów rozpoczynających się od tej liczby. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
łączny
|
total | integer |
Całkowita liczba znalezionych wpisów. |
|
limit
|
limit | integer |
Ilość zwracanych elementów. |
|
przesunąć
|
offset | integer |
Bieżące zdefiniowane przesunięcie pobierania elementów rozpoczynających się od tej liczby. |
|
dane
|
data | array of postData |
Kanały: wysyłanie wpisu do określonego kanału
Wyślij wpis do określonego kanału informacyjnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kanału
|
channelID | True | string |
Wstaw tutaj identyfikator kanału. |
|
zewnętrzny ID
|
externalID | string |
Opcjonalnie: wprowadź identyfikator zewnętrzny tutaj. |
|
|
regionalny
|
locale | string |
Wstaw ustawienia regionalne, takie jak de_DE, en_US itp. |
|
|
zawartość
|
content | string |
Tutaj wprowadź zawartość wiadomości. |
|
|
obraz (link)
|
image | string |
Tutaj wprowadź link do obrazu. |
|
|
Teaser
|
teaser | string |
Wprowadź swój teaser tutaj. |
|
|
title
|
title | string |
Wprowadź tutaj swój tytuł. |
|
|
Opublikowany
|
published | string |
Wprowadź datę opublikowaną tutaj. |
Multimedia: pobieranie multimediów według identyfikatora
Pobieranie metadanych dla pojedynczego nośnika według jego identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator średni
|
mediumID | True | string |
Żąda informacji na określonym nośniku. |
Zwraca
- Body
- mediaData
Multimedia: Pobieranie wszystkich multimediów
Żąda opisu wszystkich multimediów dostępnych w bieżącym kontekście.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ograniczenie
|
limit | integer |
Ogranicz liczbę elementów w tym miejscu. |
|
|
Przesunięcie
|
offset | integer |
Ustaw przesunięcie zapytania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
łączny
|
total | integer |
Całkowita liczba znalezionych zasobów. |
|
limit
|
limit | integer |
Ilość zwracanych elementów. |
|
przesunąć
|
offset | integer |
Bieżące zdefiniowane przesunięcie pobierania elementów rozpoczynających się od tej liczby. |
|
dane
|
data | array of mediaData |
Nośnik: usuwanie multimediów
Usuwa określony nośnik w bieżącym kontekście.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator średni
|
mediumID | True | string |
Usuwa medium według jego identyfikatora. Chociaż spowoduje to natychmiastowe usunięcie zasobu z naszych serwerów, sieć CDN może nadal dostarczać zawartość za pośrednictwem adresu URL określonego w adresie resourceInfo.url do momentu unieważnienia usługi CDN. |
Powiadomienie: wysyła powiadomienie
Wysyła powiadomienia do określonych użytkowników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
accessorIds
|
accessorIds | array of string | ||
|
regionalny
|
locale | string |
Wstaw ustawienia regionalne, takie jak de_DE, en_US itp. |
|
|
title
|
title | string |
Wstaw tytuł zależny od języka. |
|
|
łącze
|
link | string |
Optinal: Wstaw tutaj link. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Jest to identyfikator powiadomienia. |
|
accessorIds
|
recipients.accessorIds | array of string |
Jest to lista identyfikatorów adresatów. |
|
zawartość
|
content | array of object | |
|
title
|
content.title | string |
Tytuł powiadomienia, który jest zlokalizowany. |
|
regionalny
|
content.locale | string |
Jest to ustawienia regionalne tytułu. |
|
łącze
|
link | string |
To jest link powiadomienia. |
|
typ
|
type | string |
Jest to typ powiadomienia. |
|
createdAt
|
createdAt | string |
Data utworzenia powiadomienia. |
|
utworzone
|
created | string |
Data utworzenia powiadomienia. |
Serwer proxy: Pobieranie wersji
Zwraca bieżącą wersję serwera proxy.
Użytkownik: Aktualizowanie informacji o użytkowniku
Aktualizowanie informacji o użytkowniku.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userID | True | string |
Identyfikator może być oparty na identyfikatorze UserID automatycznie generowanym przez platformę Staffbase lub identyfikator externalID, jeśli zostanie dodany dla użytkownika. |
|
id
|
id | string |
Identyfikator użytkownika |
|
|
zewnętrzny ID
|
externalID | string |
Identyfikator zewnętrzny użytkownika |
|
|
imię
|
firstName | string |
Imię użytkownika |
|
|
nazwisko
|
lastName | string |
Nazwisko użytkownika |
|
|
publicEmailAddress
|
publicEmailAddress | string |
Publiczna poczta e-mail użytkownika |
|
|
regionalny
|
locale | string |
Ustawienia regionalne użytkownika |
|
|
e-mail
|
value | string |
Adres e-mail |
|
|
podstawowy
|
primary | boolean |
Czy jest to podstawowa wiadomość e-mail? |
|
|
groupIDs
|
groupIDs | array of string | ||
|
pozycja
|
position | string |
Pozycja użytkownika |
|
|
departament
|
department | string |
Dział użytkownika |
|
|
lokalizacja
|
location | string |
Lokalizacja użytkownika |
|
|
numer telefonu
|
phoneNumber | string |
Numer telefonu użytkownika |
|
|
utworzone
|
created | string |
Data utworzenia użytkownika |
|
|
aktualizowano
|
updated | string |
Zaktualizowana data użytkownika |
|
|
Aktywowany
|
activated | string |
Czy użytkownik jest aktywowany? |
Zwraca
- Body
- userData
Użytkownik: pobieranie informacji o użytkowniku
Uzyskaj określone informacje o użytkowniku według jego identyfikatora użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userID | True | string |
Identyfikator może być oparty na identyfikatorze UserID automatycznie generowanym przez platformę Staffbase lub identyfikator externalID, jeśli zostanie dodany dla użytkownika. |
Zwraca
- Body
- userData
Użytkownik: pobieranie listy użytkowników
Pobierz listę użytkowników w zależności od tokenu dostępu interfejsu API.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Notacja SCIM może służyć do filtrowania
|
filter | string |
Notacja SCIM może służyć do filtrowania. |
|
|
Wyszukiwanie pełnotekstowe można połączyć z filtrem
|
query | string |
W tym miejscu możesz serach w dowolnym polu profilu. |
Użytkownik: Usuwanie użytkownika
Usuwa określonego użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userID | True | string |
Identyfikator może być oparty na identyfikatorze UserID automatycznie generowanym przez platformę Staffbase lub identyfikator externalID, jeśli zostanie dodany dla użytkownika. |
Użytkownik: wysyłanie wiadomości e-mail z odzyskiwaniem
Wysyła wiadomość e-mail odzyskiwania do określonego użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userID | True | string |
Identyfikator może być oparty na identyfikatorze UserID automatycznie generowanym przez platformę Staffbase lub identyfikator externalID, jeśli zostanie dodany dla użytkownika. |
Użytkownik: Zapraszanie użytkownika
Użytkownik otrzyma wiadomość e-mail z informacją o rejestracji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
e-mail
|
string |
Jest to adres e-mail użytkownika. |
||
|
imię
|
firstName | string |
Jest to imię użytkownika. |
|
|
nazwisko
|
lastName | string |
Jest to nazwisko użytkownika. |
Wpisy: aktualizuje wpis
Aktualizuje wpis, tylko zmienione pole (przyrostowe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator strony
|
pageID | True | string |
Może to być identyfikator wpisu zdefiniowany przez interfejs API lub ustawienie identyfikatora post externalID. |
|
zewnętrzny ID
|
externalID | string |
Opcjonalnie: wprowadź identyfikator zewnętrzny tutaj. |
|
|
regionalny
|
locale | string |
Wstaw ustawienia regionalne, takie jak de_DE, en_US itp. |
|
|
zawartość
|
content | string |
Tutaj wprowadź zawartość wiadomości. |
|
|
obraz
|
image | string |
Tutaj wprowadź link do obrazu. |
|
|
Teaser
|
teaser | string |
Wprowadź swój teaser tutaj. |
|
|
title
|
title | string |
Wprowadź tutaj swój tytuł. |
|
|
Opublikowany
|
published | string |
Wprowadź datę opublikowaną tutaj. |
Wpisy: Pobieranie komentarzy
Pobierz listę komentarzy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Manage
|
manage | boolean |
Jeśli wartość true i rola tokenu zezwala na zarządzanie komentarzami , również nie opublikowane komentarze będą wyświetlane na liście. |
|
|
Ograniczenie
|
limit | integer |
Ilość elementów, które powinny zostać zwrócone (wartość domyślna i maksymalna 100). |
|
|
Przesunięcie
|
offset | integer |
Zdefiniuj przesunięcie pobierania elementów rozpoczynających się od tej liczby. |
|
|
Filter
|
filter | string |
Filtruj w formacie SCIM2 z częściową obsługą. Obecnie obsługiwana jest tylko płaska struktura (bez zagnieżdżonych klauzul) i klauzule porównania, takie jak eq = "equals", gt = "greater than", ge = "greater than or equals", lt = "less than", le = "less than or equals". W przypadku komentarzy obsługiwane pola filtru to: tworzone i aktualizowane. Wartość tych pól można podać w ciągu UTC DateTime reprezentującego wartości lub długą liczbę milisekund epoki unix. Przykład 1: filter=updated ge "2020-11-26T10:14:48.947Z" i zaktualizowano le "2020-11-26T10:14:48.947Z". W tym przykładzie filtr zakresu DateTime jest stosowany do zaktualizowanego pola z klauzulami porównania ge and le i klauzulą logiczną. Przykład 2: filter=created gt "2020-11-26T10:14:48.947Z". Pobierz wszystkie komentarze utworzone po wskazanej dacie. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
łączny
|
total | integer |
Całkowita liczba znalezionych komentarzy. |
|
limit
|
limit | integer |
Ilość zwracanych elementów. |
|
przesunąć
|
offset | integer |
Bieżące zdefiniowane przesunięcie pobierania elementów rozpoczynających się od tej liczby. |
|
dane
|
data | array of object | |
|
id
|
data.id | string |
Jest to identyfikator komentarza. |
|
parentID
|
data.parentID | string |
Identyfikator elementu nadrzędnego komentarza może być wpisem lub komentarzem. |
|
parentType (typ rodzica)
|
data.parentType | string |
Typ nadrzędny może być wpisem lub komentarzem. |
|
tekst komentarza
|
data.text | string |
To jest zawartość komentarzy / sam test. |
|
identyfikator wpisu
|
data.rootID | string |
Jest to identyfikator wpisu, który jest powiązany z tym komentarzem |
|
autor
|
data.author | authorObject | |
|
łączny
|
data.likes.total | integer |
Jest to liczba polubień komentarzy. |
|
isLiked
|
data.likes.isLiked | string |
Czy ten komentarz jest lubiany? |
|
utworzone
|
data.created | string |
Data utworzenia komentarza. |
|
aktualizowano
|
data.updated | string |
Zaktualizowana data komentarza. |
|
obraz
|
data.image | imageObject |
Wpisy: pobieranie listy wpisów
Pobierz listę wpisów dostępnych dla tokenu interfejsu API.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Query
|
query | string |
Ciąg, który może służyć do wyszukiwania zawartości wpisu. |
|
|
Ograniczenie
|
limit | integer |
Ilość elementów, które powinny zostać zwrócone (wartość domyślna i maksymalna 100). |
|
|
Przesunięcie
|
offset | integer |
Zdefiniuj przesunięcie pobierania elementów rozpoczynających się od tej liczby. |
|
|
Zarządzaniu
|
manageable | boolean |
Opcjonalny filtr dla danego typu zawartości wpisu. Domyślnie nie filtruje. |
|
|
Typ zawartości
|
contentType | string |
Opcjonalny filtr dla danego typu zawartości wpisu. (Domyślnie nie filtruje) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
łączny
|
total | integer |
Całkowita liczba znalezionych wpisów. |
|
limit
|
limit | integer |
Ilość zwracanych elementów. |
|
przesunąć
|
offset | integer |
Bieżące zdefiniowane przesunięcie pobierania elementów rozpoczynających się od tej liczby. |
|
dane
|
data | array of postData |
Wpisy: pobieranie wpisu według identyfikatora
Żąda określonych wpisów, w tym zestawu komentarzy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator strony
|
pageID | True | string |
Jest to identyfikator wpisu. |
Zwraca
- Body
- postData
Wpisy: usuwa wpis
Usuwa wpis z systemu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator strony
|
pageID | True | string |
Może to być identyfikator wpisu zdefiniowany przez interfejs API lub ustawienie identyfikatora post externalID. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
identifier | integer |
Identyfikator usunięcia. |
|
kod statusu
|
statusCode | integer |
Kod stanu akcji. |
|
komunikat
|
message | string |
Komunikat akcji. |
|
typ
|
type | string |
Typ akcji. |
Definicje
mediaData
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Jest to identyfikator zasobu. |
|
ownerID
|
ownerID | string |
Jest to identyfikator właściciela tego zasobu. |
|
parentID
|
parentID | string |
Jest to identyfikator elementu zawartości multimediów nadrzędnych. |
|
publicID
|
publicID | string |
Jest to publiczny identyfikator uzyskiwania dostępu do zasobu. |
|
typ
|
resourceInfo.type | string |
Jest to typ zasobu zasobu. |
|
bytes
|
resourceInfo.bytes | integer |
Jest to rozmiar zasobu (w bajtach). |
|
width
|
resourceInfo.width | integer |
Jest to szerokość zasobu. |
|
height
|
resourceInfo.height | integer |
Jest to wysokość zasobu. |
|
URL
|
resourceInfo.url | string |
Jest to adres URL zasobu. |
|
format
|
resourceInfo.format | string |
Jest to format zasobu. |
|
mimeType (typ mime)
|
resourceInfo.mimeType | string |
Jest to typ MIME zasobu. |
|
fileName
|
fileName | string |
Jest to nazwa pliku nośnika. |
|
title
|
title | string |
Jest to tytuł nośnika. |
|
etykieta
|
label | string |
Jest to etykieta nośnika. |
|
utworzone
|
created | string |
Data utworzenia elementu zawartości. |
userData (dane użytkownika)
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator użytkownika |
|
zewnętrzny ID
|
externalID | string |
Identyfikator zewnętrzny użytkownika |
|
imię
|
firstName | string |
Imię użytkownika |
|
nazwisko
|
lastName | string |
Nazwisko użytkownika |
|
publicEmailAddress
|
publicEmailAddress | string |
Publiczna poczta e-mail użytkownika |
|
regionalny
|
config.locale | string |
Ustawienia regionalne użytkownika |
|
wiadomości e-mail
|
emails | array of object |
Informacje e-mail użytkownika |
|
e-mail
|
emails.value | string |
Adres e-mail |
|
podstawowy
|
emails.primary | boolean |
Czy jest to podstawowa wiadomość e-mail? |
|
groupIDs
|
groupIDs | array of string | |
|
pozycja
|
position | string |
Pozycja użytkownika |
|
departament
|
department | string |
Dział użytkownika |
|
lokalizacja
|
location | string |
Lokalizacja użytkownika |
|
numer telefonu
|
phoneNumber | string |
Numer telefonu użytkownika |
|
utworzone
|
created | string |
Data utworzenia użytkownika |
|
aktualizowano
|
updated | string |
Zaktualizowana data użytkownika |
|
Aktywowany
|
activated | string |
Czy użytkownik jest aktywowany? |
postData
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator wpisu. |
|
autor
|
author | authorObject | |
|
contents
|
contents | array of object | |
|
zawartość
|
contents.content | string |
Zawartość wpisu zlokalizowana. |
|
obraz
|
contents.image | imageObject | |
|
Teaser
|
contents.teaser | string |
Teaser post, który jest zlokalizowany. |
|
title
|
contents.title | string |
Tytuł wpisu zlokalizowany. |
|
regionalny
|
contents.locale | string |
Jest to ustawienia regionalne elementu. |
|
id
|
channel.id | string |
Jest to identyfikator kanału. |
|
lokalizacja
|
channel.config.localization | array of object | |
|
title
|
channel.config.localization.title | string |
To jest tytuł kanału, który jest zlokalizowany. |
|
regionalny
|
channel.config.localization.locale | string |
Jest to ustawienia regionalne tytułu kanału. |
|
Opublikowany
|
published | string |
Data publikacji wpisu. |
|
utworzone
|
created | string |
Data utworzenia wpisu. |
|
aktualizowano
|
updated | string |
Zaktualizowana data wpisu. |
authorObject
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
imię
|
firstName | string |
Jest to imię autora. |
|
id
|
id | string |
Jest to identyfikator autora. |
|
nazwisko
|
lastName | string |
Jest to nazwisko autora. |
|
URL
|
avatar.original.url | string |
Jest to oryginalny adres URL obrazu awatara autora. |
|
width
|
avatar.original.width | integer |
Jest to oryginalna szerokość obrazu awatara autora. |
|
height
|
avatar.original.height | integer |
Jest to oryginalna wysokość obrazu awatara autora. |
|
size
|
avatar.original.size | integer |
Jest to oryginalny obraz awatara autora sie (w bajtach). |
|
format
|
avatar.original.format | string |
Jest to oryginalny format awatara autora. |
|
mimeType (typ mime)
|
avatar.original.mimeType | string |
Jest to obraz awatara athor oryginalny mimeType. |
|
utworzone
|
avatar.original.created | string |
Jest to oryginalna data utworzenia awatara autora. |
|
URL
|
avatar.icon.url | string |
Jest to adres URL ikony awatara autora. |
|
width
|
avatar.icon.width | integer |
Jest to szerokość ikony awatara autora. |
|
height
|
avatar.icon.height | integer |
Jest to wysokość ikony awatara autora. |
|
format
|
avatar.icon.format | string |
Jest to format ikony awatara autora. |
|
mimeType (typ mime)
|
avatar.icon.mimeType | string |
Jest to ikona awatara autora mimeType. |
|
URL
|
avatar.thumb.url | string |
Jest to adres URL kciuka awatara autora. |
|
width
|
avatar.thumb.width | integer |
Jest to szerokość kciuka awatara autora. |
|
height
|
avatar.thumb.height | integer |
Jest to wysokość kciuka awatara autora. |
|
format
|
avatar.thumb.format | string |
Jest to format kciuka awatara autora. |
|
mimeType (typ mime)
|
avatar.thumb.mimeType | string |
To jest athor awatar mimeType kciuka. |
|
publicID
|
avatar.publicID | string |
Jest to identyfikator publiczny awatara autora. |
imageObject
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
URL
|
original.url | string |
Jest to oryginalny adres URL obrazu. |
|
width
|
original.width | integer |
Jest to oryginalna szerokość obrazu. |
|
height
|
original.height | integer |
Jest to oryginalna wysokość obrazu. |
|
size
|
original.size | integer |
Jest to oryginalny rozmiar obrazu (w bajtach). |
|
format
|
original.format | string |
Jest to oryginalny format obrazu. |
|
mimeType (typ mime)
|
original.mimeType | string |
Jest to oryginalny obraz mimeType. |
|
URL
|
original_scaled.url | string |
Jest to oryginalny adres URL obrazu. |
|
width
|
original_scaled.width | integer |
Jest to oryginalna szerokość obrazu. |
|
height
|
original_scaled.height | integer |
Jest to oryginalna wysokość obrazu. |
|
format
|
original_scaled.format | string |
Jest to oryginalny format obrazu. |
|
mimeType (typ mime)
|
original_scaled.mimeType | string |
Jest to oryginalny obraz mimeType. |
|
URL
|
compact.url | string |
Jest to kompaktowy adres URL obrazu. |
|
width
|
compact.width | integer |
Jest to kompaktowana szerokość obrazu. |
|
height
|
compact.height | integer |
Jest to kompaktowanie wysokości obrazu. |
|
format
|
compact.format | string |
Jest to format kompaktowy obrazu. |
|
mimeType (typ mime)
|
compact.mimeType | string |
Jest to obraz compact mimeType. |