Dynamic Signal (wersja zapoznawcza)
Dynamic Signal to platforma komunikacji pracowników i zaangażowania, zaufana przez organizacje w celu łączenia się, dopasowywania i angażowania pracowników. Połącz się z usługą Dynamic Signal, aby utworzyć wpisy i użytkowników oraz zarządzać nimi.
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) |
| Metadane łącznika | |
|---|---|
| Publisher | Sygnał dynamiczny |
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 |
|---|---|---|---|
| Token elementu nośnego | securestring | Token elementu nośnego dla tego interfejsu API | Prawda |
| Adres URL sygnału dynamicznego | ciąg | Adres URL, pod którym uzyskujesz dostęp do aplikacji Dynamic Signal. | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie wpisu |
Edytuje istniejący wpis. |
| Dodawanie obrazu do wpisu za pośrednictwem adresu URL |
Ustawia obraz wpisu za pośrednictwem adresu URL. |
| Dodawanie obrazu do wpisu za pośrednictwem przekazywania |
Ustawia obraz postu za pośrednictwem przekazywania binarnego. |
| Pobieranie elementów docelowych |
Pobiera listę celów i definicji docelowych społeczności |
| Pobieranie kategorii |
Pobiera listę kategorii widocznych dla uwierzytelnionego użytkownika |
| Pobieranie podziałów |
Pobiera listę podziałów |
| Pobieranie tagów postów |
Pobiera tagi post zdefiniowane w systemie |
| Pobieranie tagów użytkowników |
Pobiera listę tagów użytkownika zdefiniowanych w systemie |
| Pobieranie użytkownika pocztą e-mail |
Pobiera użytkownika na swój adres e-mail |
| Pobieranie wpisu |
Pobiera określony wpis według identyfikatora |
| Przekazywanie dokumentu do wpisu |
Przekazuje dokument do wpisu za pośrednictwem przekazywania binarnego |
| Przekazywanie obrazu |
Przekazuje obraz za pośrednictwem przekazywania binarnego |
| Tworzenie wpisu |
Tworzy wpis. |
| Wstępne wyrejestrowanie użytkownika |
Tworzy nowego użytkownika w stanie wstępnie wyrejestrowanym |
| Zarządzanie wpisami |
Zezwala na uwierzytelnione przez serwer wywołania w celu zaktualizowania właściwości wielu wpisów w jednym żądaniu |
Aktualizowanie wpisu
Edytuje istniejący wpis.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | uuid |
Identyfikator wpisu |
|
Title
|
title | string |
Tytuł wpisu |
|
|
Description
|
description | string |
Krótki opis wpisu |
|
|
Linia tagu
|
tagLine | string |
Wiersz tagu wpisu |
|
|
Content
|
content | string |
Treść wpisu |
|
|
Komentarze twórców
|
creatorComments | string |
Wiadomość skojarzona z wpisem |
|
|
Łącze perma
|
permaLink | string |
Zewnętrzny adres URL, do których odwołuje się wpis |
|
|
Włączone dyskusje wewnętrzne
|
internalDiscussionsEnabled | boolean |
Czy członkowie mogą wykonywać akcje podobne do akcji i dodawać komentarze do wpisów wewnętrznie |
Zwraca
Wpis
- response
- postResponse
Dodawanie obrazu do wpisu za pośrednictwem adresu URL
Ustawia obraz wpisu za pośrednictwem adresu URL.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | uuid |
Wymagany identyfikator wpisu: true |
|
URL
|
url | True | string |
Adres URL HTTP lub HTTPS |
Zwraca
Prosta odpowiedź wskazująca, że akcja została przeprowadzona pomyślnie
- response
- successResponse
Dodawanie obrazu do wpisu za pośrednictwem przekazywania
Ustawia obraz postu za pośrednictwem przekazywania binarnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | uuid |
Identyfikator wpisu |
|
File
|
File | True | binary |
Plik do przekazania |
|
Typ zawartości, taki jak image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Typ zawartości przekazanego pliku |
Zwraca
Prosta odpowiedź wskazująca, że akcja została przeprowadzona pomyślnie
- response
- successResponse
Pobieranie elementów docelowych
Pobiera listę celów i definicji docelowych społeczności
Zwraca
Lista definicji docelowych i skojarzonych celów dla społeczności.
- response
- targetDefinitionsInfoResponse
Pobieranie kategorii
Pobiera listę kategorii widocznych dla uwierzytelnionego użytkownika
Zwraca
Szczegółowe informacje dotyczące kategorii
- response
- categoriesResponse
Pobieranie podziałów
Pobieranie tagów postów
Pobiera tagi post zdefiniowane w systemie
Zwraca
Lista tagów post zdefiniowanych w systemie
- response
- managePostTagsResponse
Pobieranie tagów użytkowników
Pobiera listę tagów użytkownika zdefiniowanych w systemie
Zwraca
Lista tagów użytkownika zdefiniowanych w systemie
- response
- manageUserTagsResponse
Pobieranie użytkownika pocztą e-mail
Pobiera użytkownika na swój adres e-mail
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Email
|
True | string |
Adres e-mail użytkownika |
|
|
Zawierać
|
include | array of string |
Określa opcjonalne dane, które mają być zwracane przez użytkownika. |
Zwraca
- response
- userRequestResponse
Pobieranie wpisu
Pobiera określony wpis według identyfikatora
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | uuid |
Identyfikator wpisu. Jest to unikatowy identyfikator wpisu. |
|
Identyfikator użytkownika
|
userId | integer |
Użytkownik wyświetlający wpis. Zalogowany użytkownik będzie używany, jeśli nie określono żadnego identyfikatora |
Zwraca
Wpis
- response
- postResponse
Przekazywanie dokumentu do wpisu
Przekazuje dokument do wpisu za pośrednictwem przekazywania binarnego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa pliku
|
fileName | True | string |
Preferowana nazwa pliku dokumentu (z rozszerzeniem) |
|
identyfikator
|
id | True | uuid |
Identyfikator wpisu |
|
File
|
File | True | binary |
Plik do przekazania |
|
Typ zawartości, taki jak image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Typ zawartości przekazanego pliku |
Zwraca
Informacje istotne dla dołączonego dokumentu
- response
- documentInfoResponse
Przekazywanie obrazu
Przekazuje obraz za pośrednictwem przekazywania binarnego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
File
|
File | True | binary |
Plik do przekazania |
|
Typ zawartości, taki jak image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Typ zawartości przekazanego pliku |
Zwraca
- response
- uploadImageResponse
Tworzenie wpisu
Tworzy wpis.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Description
|
description | string |
Krótki opis wpisu |
|
|
Linia tagu
|
tagLine | string |
Wiersz tagu wpisu |
|
|
Content
|
content | string |
Treść wpisu |
|
|
Komentarze twórców
|
creatorComments | string |
Wiadomość skojarzona z wpisem |
|
|
Łącze perma
|
permaLink | string |
Zewnętrzny adres URL, do których odwołuje się wpis |
|
|
Włączone dyskusje wewnętrzne
|
internalDiscussionsEnabled | boolean |
Czy członkowie mogą wykonywać akcje podobne do akcji i dodawać komentarze do wpisów wewnętrznie |
|
|
Title
|
title | True | string |
Tytuł wpisu |
|
Adres URL wideo elementu członkowskiego
|
memberVideoUrl | string |
Adres URL wideo, do których odwołuje się wpis |
|
|
Typ wpisu
|
postType | string |
Podstawowy typ wpisu |
|
|
Stan zatwierdzenia
|
approvalState | string |
Stan zatwierdzenia wpisu. Domyślnie jest to ustawienie Stan przeglądu autora. |
|
|
Tryb wyświetlania
|
displayMode | string |
Wskazuje przekierowanie wpisu do lokalizacji wewnętrznej lub zewnętrznej |
|
|
Sharable
|
sharable | boolean |
Czy platforma VoiceStorm i widżety będą zezwalać na udostępnianie wpisu |
|
|
Data rozpoczęcia
|
startDate | date-time |
Data, po której wpis jest dostępny do wyświetlenia |
|
|
Data zakończenia
|
endDate | date-time |
Data, po której wpis nie będzie już dostępny do wyświetlania |
|
|
Sugerowany tekst udziału
|
suggestedShareText | string |
Sugerowany tekst udziału dla wpisu |
|
|
Krótki sugerowany tekst udziału
|
shortSuggestedShareText | string |
Sugerowany tekst udziału dla wpisu dla krótkich dostawców wiadomości |
|
|
Punkty udziału
|
sharePoints | integer |
Liczba punktów przyznanych, gdy użytkownik udostępni wpis |
|
|
Klikanie punktów
|
clickPoints | integer |
Liczba punktów przyznanych po kliknięciu przez kogoś udostępnionego linku do wpisu |
|
|
Udostępnianie obrazom
|
shareWithImages | boolean |
Określa, czy wpisy udostępnione krótkim usługom wiadomości (na przykład Twitter) mają udostępnione obrazy |
|
|
Udostępnianie tylko obrazów
|
shareImagesOnly | boolean |
Określa, czy wpisy udostępnione niektórym usługom są traktowane jako aktualizacje tylko obraz/zdjęcie |
|
|
Name
|
name | string |
Nazwa tagu |
|
|
Język
|
language | string |
Język zawartości wpisu |
|
|
Documents
|
documents | array of uuid |
Lista identyfikatorów dokumentów do dołączenia do tego wpisu |
|
|
Identyfikator twórcy
|
creatorId | integer |
Użytkownik tworzący wpis; Ta właściwość jest obecnie dostępna tylko dla żądań uwierzytelnionych przez serwer. Wszystkie inne wpisy są automatycznie ustawiane na uwierzytelnionego użytkownika. |
|
|
Wyświetl twórcę
|
displayCreator | boolean |
Określa, czy informacje o twórcy mają być wyświetlane za pomocą wpisu, czy nie; Ta właściwość jest obecnie dostępna tylko dla żądań uwierzytelnionych przez serwer. |
|
|
Identyfikatory kategorii
|
categoryIds | array of integer |
Lista identyfikatorów kategorii, które zostały przypisane do wpisu |
|
|
Identyfikatory docelowe
|
targetIds | array of integer |
Lista identyfikatorów docelowych, które zostały przypisane do wpisu |
Zwraca
Wpis
- response
- postResponse
Wstępne wyrejestrowanie użytkownika
Tworzy nowego użytkownika w stanie wstępnie wyrejestrowanym
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Email
|
string |
Adres e-mail użytkownika |
||
|
Identyfikator użytkownika logowania jednokrotnego zewnętrznego
|
externalSsoUserId | string |
Identyfikator użytkownika w systemie zewnętrznym zarządzanym przez dostawcę tożsamości logowania jednokrotnego |
|
|
Uchwyt
|
handle | string |
Uchwyt użytkownika |
|
|
Imię
|
firstName | string |
Imię użytkownika. |
|
|
Nazwisko
|
lastName | string |
Nazwisko użytkownika. |
|
|
Identyfikatory podziałów
|
divisionIds | array of integer |
Lista podziałów, do których zostanie przypisany użytkownik. |
|
|
Identyfikatory docelowe
|
targetIds | array of integer |
Lista obiektów docelowych do przypisania do użytkownika. |
|
|
Name
|
name | string |
Nazwa tagu lub atrybutu |
|
|
Wartość
|
value | string |
Wartość opcjonalna |
|
|
Wyślij wiadomość e-mail z zaproszeniem
|
sendInvitationEmail | boolean |
Określa, czy wysłać wiadomość e-mail z zaproszeniem do użytkownika. |
|
|
Wiadomość z zaproszeniem
|
invitationMessage | string |
Opcjonalna wiadomość w postaci zwykłego tekstu do uwzględnienia w wiadomości e-mail z zaproszeniem. |
|
|
Domyślne powiadomienia
|
notificationsDefault | string |
Ustawienie, które określa, kiedy użytkownicy zaczną otrzymywać powiadomienia e-mail. |
|
|
Może udostępniać wpisy
|
canSharePosts | boolean |
Wskazuje, czy użytkownik ma możliwość udostępniania wpisów |
|
|
Może komentować wpisy
|
canCommentPosts | boolean |
Wskazuje, czy użytkownik ma możliwość komentowania i polubień wpisów |
|
|
Może przesyłać wpisy
|
canSubmitPosts | boolean |
Wskazuje, czy użytkownik ma możliwość przesyłania wpisów |
|
|
Może zarządzać organizacją
|
canManageOrganization | boolean |
Wskazuje, czy użytkownik ma możliwość komunikowania się z raportami bezpośrednimi i pośrednimi w społeczności |
Zwraca
- response
- userRequestResponse
Zarządzanie wpisami
Zezwala na uwierzytelnione przez serwer wywołania w celu zaktualizowania właściwości wielu wpisów w jednym żądaniu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikatory postów
|
postIds | True | array of uuid |
Wpisy, które są modyfikowane |
|
Etykiety
|
tags | array of string |
Kolekcja nazw tagów, które można zastosować do wpisów |
|
|
Identyfikatory podziałów
|
divisionIds | array of integer |
Identyfikatory podziałów, do których należą wpisy |
|
|
Identyfikatory kategorii
|
categoryIds | array of integer |
Identyfikator kategorii, do którego należą wpisy |
|
|
Identyfikatory docelowe
|
targetIds | array of integer |
Identyfikator docelowy, do którego należą wpisy |
|
|
Stan zatwierdzenia
|
approvalState | string |
Stan zatwierdzenia dla wpisów (nie ma to wpływu na żądania DELETE) |
Zwraca
Prosta odpowiedź wskazująca, że akcja została przeprowadzona pomyślnie
- response
- successResponse
Definicje
successResponse
Prosta odpowiedź wskazująca, że akcja została przeprowadzona pomyślnie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Code
|
code | string |
Wartość "success" wskazuje pomyślną operację |
targetDefinitionsInfoResponse
Lista definicji docelowych i skojarzonych celów dla społeczności.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfoResponse
Szczegółowe informacje dotyczące określonej definicji miejsca docelowego i skojarzonych z nią elementów docelowych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator definicji docelowej |
|
Name
|
name | string |
Nazwa definicji docelowej |
|
Uzyskiwanie potwierdzenia użytkownika
|
getUserConfirmation | boolean |
Określa, czy użytkownik jest proszony o potwierdzenie/wybranie preferencji |
|
Zezwalaj na wiele zaznaczeń
|
allowMultipleSelections | boolean |
Określa, czy można wybrać wiele obiektów docelowych |
|
Wymagany wybór
|
selectionRequired | boolean |
Określa, czy wybór w tej definicji jest wymagany |
|
Monit o wybór docelowy
|
targetSelectionPrompt | string |
Etykieta dostosowana w celu monitowania użytkowników o wybranie ich preferencji |
|
childTargets
|
childTargets | array of targetInfoResponse |
targetInfoResponse
Szczegółowe informacje dotyczące określonego celu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator docelowy |
|
Name
|
name | string |
Nazwa obiektu docelowego |
|
Description
|
description | string |
Cele descritption |
|
Identyfikator definicji
|
definitionId | integer |
Identyfikator definicji docelowej, do którego należy element docelowy |
|
Identyfikator nadrzędny
|
parentId | integer |
Identyfikator obiektu nadrzędnego obiektów docelowych, jeśli ma jeden |
|
Jest subskrybowany
|
isSubscribed | boolean |
Czy użytkownik jest subskrybowany do określonego miejsca docelowego |
|
childTargets
|
childTargets | array of targetInfoResponse1 |
managePostTagsResponse
Lista tagów post zdefiniowanych w systemie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTagResponse
Szczegółowe informacje dotyczące określonego tagu post
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator tagu |
|
Name
|
name | string |
Nazwa tagu |
|
Jest dostępny dla członków
|
isAvailableToMembers | boolean |
Określa, czy tag można użyć na stronach przesyłania po przesłaniu po stronie elementu członkowskiego (jeśli jest włączony) |
manageUserTagsResponse
Lista tagów użytkownika zdefiniowanych w systemie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTagResponse
Szczegółowe informacje dotyczące określonego tagu użytkownika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator tagu |
|
Name
|
name | string |
Nazwa tagu |
|
typ
|
type | string | |
|
acceptedValues
|
acceptedValues | array of string |
categoriesResponse
Szczegółowe informacje dotyczące kategorii
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
Monit o subskrypcję
|
subscriptionPrompt | string |
Etykieta monitowania członków o wybranie subskrypcji kategorii |
|
Włączanie subskrypcji kategorii
|
enableCategorySubscription | boolean |
Czy członkowie mogą modyfikować swoje subskrypcje kategorii |
|
Wymagaj wyboru subskrypcji
|
requireSubscriptionSelection | boolean |
Czy członkowie są zobowiązani do wybierania subskrypcji kategorii podczas dołączania |
|
Kategoria domyślna strony docelowej
|
landingPageDefaultCategory | integer |
Domyślna zawartość wyświetlana podczas ładowania informacji z kanału informacyjnego wiadomości |
categoryResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator kategorii |
|
Name
|
name | string |
Nazwa kategorii |
|
Description
|
description | string |
Opis kategorii |
|
Kolejność wyświetlania
|
displayOrder | integer |
Kolejność wyświetlania kategorii |
|
Jest przypięty
|
isPinned | boolean |
Czy kategoria została przypięta przez administratora |
|
Jest wymuszone
|
isForced | boolean |
Czy uwierzytelniony użytkownik jest wymusić subskrybowanie danej kategorii |
|
Jest subskrybowany
|
isSubscribed | boolean |
Wther uwierzytelniony użytkownik jest subskrybowany do danej kategorii |
|
Jest ukryty
|
isHidden | boolean |
Czy kategoria jest ukryta przez administratora |
|
Czy użytkownik może wybrać
|
isUserSelectable | boolean |
Czy użytkownicy mogą wybierać kategorie dla przesłanych wpisów |
|
Identyfikator kategorii nadrzędnej
|
parentCategoryId | integer |
Identyfikator kategorii nadrzędnej |
|
childCategories
|
childCategories | array of categoryResponse1 |
postResponse
Wpis
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator wpisu
|
postId | uuid |
Identyfikator wpisu |
|
Identyfikator źródła wpisu
|
postSourceId | integer |
Identyfikator źródła |
|
Title
|
title | string |
Tytuł wpisu |
|
Description
|
description | string |
Krótki opis wpisu |
|
Linia tagu
|
tagLine | string |
Wiersz tagu wpisu |
|
Content
|
content | string |
Treść wpisu |
|
Nieprzetworzona zawartość
|
rawContent | string |
Treść wpisu, w tym cały kod HTML (gdy uwzględniona jest zawartość i element RawContent) |
|
Komentarze twórców
|
creatorComments | string |
Wiadomość skojarzona z wpisem |
|
|
creatorInfo | userOverviewResponse |
Podsumowanie informacji o użytkowniku |
|
Lokalizacja
|
location | string |
Lokalizacja geograficzna powiązana z wpisem |
|
Właściwości
|
properties | object |
Różne właściwości wpisu. Niedostępne we wszystkich typach postów |
|
Łącze perma
|
permaLink | string |
Zewnętrzny adres URL, do których odwołuje się wpis |
|
Wyczyść łącze perma
|
cleanPermaLink | string |
Permalink (z wyłączeniem problematycznych spacji i nowych linii) |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postBylineType
|
postBylineType | string | |
|
Provider
|
provider | string |
Dostawca społecznościowy, z którego pochodzi post (np. Facebook, Twitter). |
|
approvalState
|
approvalState | string | |
|
displayMode
|
displayMode | string | |
|
stan
|
status | string | |
|
Użytkownik może edytować
|
userEditable | boolean | |
|
Użytkownik, który można udostępnić
|
userShareable | boolean |
Wskazuje, czy bieżący użytkownik może udostępnić wpis. Jeśli bieżący użytkownik nie ma, wartość domyślna to true. |
|
Użytkownik z możliwością komentowania
|
userCommentable | boolean |
Wskazuje, czy bieżący użytkownik może uczestniczyć w dykusjach w poście. Jeśli bieżący użytkownik nie ma, wartość domyślna to false. |
|
Sharable
|
sharable | boolean |
Czy platforma i widżety będą zezwalać na udostępnianie wpisu |
|
Transmitowane
|
broadcasted | boolean |
Czy wpis został rozgłaszany dla użytkowników w celu udostępniania |
|
Przypięte
|
pinned | boolean |
Czy wpis został ustawiony dla priorytetu wyświetlania w strumieniach |
|
Data publikacji
|
publishDate | date-time |
W przypadku zawartości przesłanej przez użytkownika data przesłania; w przypadku zawartości importowanej ze źródła zewnętrznego data publikacji zgodnie ze źródłem |
|
Data rozpoczęcia
|
startDate | date-time |
Data, po której wpis jest dostępny do wyświetlenia |
|
Data zakończenia
|
endDate | date-time |
Data, po której wpis nie będzie już dostępny do wyświetlania |
|
Data rozpoczęcia zdarzenia
|
eventStartDate | date-time |
Data rozpoczęcia zdarzenia (w przypadku wpisów typu zdarzenia) |
|
Data zakończenia zdarzenia
|
eventEndDate | date-time |
Data zakończenia zdarzenia (w przypadku wpisów typu zdarzenia) |
|
Sygnatura czasowa dostawcy
|
providerTimeStamp | date-time |
Data wpisu z perspektywy dostawców, tj. kiedy została pierwotnie wysłana na dostawcę usług społecznościowych |
|
Odebrane punkty publikowania
|
receivedPublishPoints | boolean |
Czy użytkownik, który przesłał post, otrzymał punkty po opublikowaniu wpisu |
|
Sugerowany tekst udziału
|
suggestedShareText | string |
Sugerowany tekst udziału dla wpisu |
|
Krótki sugerowany tekst udziału
|
shortSuggestedShareText | string |
Sugerowany tekst udziału dla wpisu dla krótkich dostawców wiadomości |
|
suggestedShareTextList
|
suggestedShareTextList | array of string | |
|
shortSuggestedShareTextList
|
shortSuggestedShareTextList | array of string | |
|
Punkty udziału
|
sharePoints | integer |
Liczba punktów przyznanych, gdy użytkownik udostępni wpis |
|
Klikanie punktów
|
clickPoints | integer |
Liczba punktów przyznanych po kliknięciu przez kogoś udostępnionego linku do wpisu |
|
Identyfikator wpisu dostawcy
|
providerPostId | string |
Oryginalny identyfikator wpisu w sieci dostawców |
|
Url Slug
|
urlSlug | string |
Tekst seo umieścić w publicznych linkach do postu |
|
Classification
|
classification | string |
Typ wpisu w sieci dostawców. |
|
Udostępnianie obrazom
|
shareWithImages | boolean |
Określa, czy wpisy udostępnione krótkim usługom wiadomości (na przykład Twitter) mają udostępnione obrazy |
|
Udostępnianie tylko obrazów
|
shareImagesOnly | boolean |
Określa, czy wpisy udostępnione niektórym usługom są traktowane jako aktualizacje tylko obraz/zdjęcie |
|
Czynności
|
actions | string |
Obiekt blob JSON zawierający listę elementów akcji dla wpisu i adresów URL |
|
Wspomina
|
mentions | string |
Wzmianki (użytkownicy, tagi skrótu itp.) są przechowywane jako obiekt blob JSON. |
|
|
statistics | postStatisticsResponse | |
|
|
userShareInfo | postUserShareInfoResponse | |
|
|
author | postAuthorRequestResponse | |
|
links
|
links | array of postLinkRequestResponse | |
|
tags
|
tags | array of postTagRequestResponse | |
|
multimedia
|
media | array of postMediaRequestResponse | |
|
images
|
images | object | |
|
candidateImages
|
candidateImages | array of postCandidateImageResponse | |
|
Widoczny
|
visible | boolean |
Czy wpis jest obecnie widoczny |
|
shareDisclosures
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareCommentRules
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
Język
|
language | string |
Język zawartości wpisu |
|
Użytkownik ukryty
|
userHidden | boolean |
Czy użytkownik ukrył wpis z co najmniej jednego strumienia |
|
Jest wyświetlany przez użytkownika
|
isViewedByUser | boolean |
Czy wpis został wyświetlany przez bieżącego użytkownika. |
|
Czy dyskusja jest widoczna przez użytkownika
|
isDiscussionViewedByUser | boolean |
Czy wątek dyskusji wpisów został wyświetlany przez bieżącego użytkownika |
|
Jest lubiany przez użytkownika
|
isLikedByUser | boolean |
Czy wpis został wewnętrznie lubiany przez bieżącego użytkownika. |
|
Jest komentowany przez użytkownika
|
isCommentedByUser | boolean |
Czy wpis został skomentowany przez bieżącego użytkownika. |
|
Jest współużytkowany przez użytkownika
|
isSharedByUser | boolean |
Czy wpis został wcześniej udostępniony przez bieżącego użytkownika |
|
targets
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
Bieżący czas
|
currentTime | date-time |
Bieżący czas na serwerze. |
categoryOverviewResponse
Podstawowe informacje o kategorii
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator kategorii |
|
Name
|
name | string |
Nazwa kategorii |
|
Identyfikator kategorii nadrzędnej
|
parentCategoryId | integer |
Identyfikator kategorii nadrzędnej |
targetOverviewResponse
Uproszczona odpowiedź docelowa składająca się z nazwy, identyfikatora i identyfikatora definicji docelowej, do którego należy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
name | string |
Nazwa elementów docelowych |
|
identyfikator
|
id | integer |
Identyfikator obiektów docelowych |
|
Identyfikator definicji
|
definitionId | integer |
Identyfikator definicji docelowej, do której należy element docelowy |
postShareCommentRulesResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dostawca
|
provider | string | |
|
Udostępnianie maksymalnego limitu znaków
|
shareMaxCharacterLimit | integer |
Maksymalna długość komentarza użytkowników w udziale dla tego dostawcy. |
postShareDisclosureResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dostawca
|
provider | string | |
|
Nazwa wyświetlana dostawcy
|
providerDisplayName | string |
Nazwa wyświetlana dostawców |
|
Udostępnianie tekstu ujawnienia
|
shareDisclosureText | string |
Tekst ujawnienia dołączony do każdego udziału |
postCandidateImageResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
URL
|
url | string |
Adres URL obrazów |
|
Szerokość
|
width | integer |
Szerokość obrazów |
|
Wysokość
|
height | integer |
Wysokość obrazów |
|
Typ mime
|
mimeType | string |
Typ MIME obrazów |
|
Ssl Url
|
sslUrl | string |
Bezpieczny adres URL obrazów |
postMediaRequestResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
name | string |
Nazwa obiektu nośnika |
|
Szerokość
|
width | integer |
Szerokość obiektu nośnika w pikselach |
|
Wysokość
|
height | integer |
Wysokość obiektu nośnika w pikselach |
|
Typ mime
|
mimeType | string |
Typ MIME obiektu nośnika |
|
Html
|
html | string |
Kod HTML, który może służyć do renderowania obiektu nośnika |
|
URL
|
url | string |
Adres URL obiektu nośnika |
|
Pochodzenie
|
origin | string |
Jeśli jest dostępna, określa oryginalną lokalizację obiektu nośnika |
|
Provider
|
provider | string |
Nazwa dostawcy społecznościowego |
|
Role
|
role | string |
Typ nośnika (jeśli jest określony) |
|
Czas trwania
|
duration | integer |
Czas trwania wideo w milisekundach |
|
Description
|
description | string |
Opis formatu wideo |
|
Ma adres URL wideo
|
hasVideoUrl | boolean |
Wskazuje, że ten nośnik ma adres URL wideo, który musi być podpisany przy użyciu dołączania "WatchVideo" |
postTagRequestResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
name | string |
Nazwa tagu |
postLinkRequestResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
URL
|
url | string |
Adres URL wpisów |
|
Rozwinięty adres URL
|
expandedUrl | string |
Rozwinięty adres URL (jeśli istnieje) |
|
Title
|
title | string |
Tytuł wpisów |
|
Domena
|
domain | string |
Domena łączy |
|
Favicon Url
|
faviconUrl | string |
Adres URL favicon linku |
|
Name
|
name | string |
Nazwa linku przypisanego przez dostawcę społecznościowego |
|
Napisy
|
caption | string |
Krótki podpis linku (tj. tekst pod linkiem) |
|
Description
|
description | string |
Opis linku (tj. dłuższy tekst pod podpisem) |
|
Data modyfikacji
|
modifiedDate | date-time | |
|
Data utworzenia
|
createdDate | date-time |
postAuthorRequestResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Author
|
author | string |
Zapisany tekst do wyświetlenia jako autor. |
|
Adres URL obrazu profilu
|
profileImageUrl | string |
Autorzy profilują zdjęcie w sieci społecznościowej |
|
Identyfikator użytkownika dostawcy
|
providerUserId | string |
Identyfikator autorów w sieci społecznościowej |
|
Nazwa użytkownika dostawcy
|
providerUserName | string |
Autorzy nazywają się w sieci społecznościowej |
|
Adres URL profilu
|
profileUrl | string |
Adres URL profilu autorów w sieci społecznościowej |
|
Nazwa źródła
|
postSourceName | string |
Nazwa źródła wpisu. |
|
Witryna źródłowa
|
postSourceSite | string |
Witryna internetowa, w której pochodzi post |
postUserShareInfoResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Punkty uzyskane
|
pointsEarned | integer |
Liczba punktów uzyskanych przez użytkownika do udostępniania |
|
Liczba udziałów
|
shareCount | integer |
Liczba udostępnionych przez użytkownika |
|
Data ostatniego udostępniania
|
mostRecentShareDate | date-time |
Data ostatniego udziału użytkowników w tym wpisie |
postStatisticsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Łączna liczba udziałów aplikacji
|
totalInAppShareCount | integer |
Synonim dla shareCount |
|
Identyfikator śledzenia
|
trackingId | string | |
|
Liczba udziałów
|
shareCount | integer |
Liczba udziałów zainicjowanych w aplikacji, które zostały zweryfikowane jako pomyślnie udostępnione |
|
Liczba reakcji
|
reactionCount | integer |
Liczba reakcji (takich jak, retweets itp.) do akcji |
|
Liczba wyświetleń
|
impressionCount | integer |
Potencjalne poglądy na post przez znajomych i zwolenników sharers |
|
Liczba wyświetleń
|
viewedCount | integer |
Liczba wizyt w wpisie przez zalogowanych użytkowników |
|
Kliknij pozycję Liczba
|
clickCount | integer |
Liczba kliknięć do linku postów z udziałów |
|
Podobnie jak liczba
|
likeCount | integer |
Liczba wewnętrznych polubień na poście |
|
Liczba komentarzy
|
commentCount | integer |
Liczba wewnętrznych komentarzy w poście |
|
Liczba komentarzy, takich jak liczba
|
commentLikeCount | integer |
Suma wszystkich polubień we wszystkich komentarzach wewnętrznych w poście |
userOverviewResponse
Podsumowanie informacji o użytkowniku
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator użytkownika
|
userId | integer |
Identyfikator użytkownika |
|
Wyświetlana nazwa
|
displayName | string |
Wyświetlana nazwa użytkownika |
|
profilePictureImages
|
profilePictureImages | object | |
|
Jest aktywny
|
isActive | boolean |
Czy użytkownik jest nadal aktywnym członkiem społeczności |
uploadImageResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator obrazu
|
imageIdentifier | string |
Identyfikator przekazanego obrazu |
userRequestResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator wewnętrzny użytkowników |
|
Email
|
string |
Adres e-mail użytkowników |
|
|
Uchwyt
|
handle | string |
Użytkownicy obsługują ("nazwa użytkownika") |
|
Wyświetlana nazwa
|
displayName | string |
Preferowana nazwa wyświetlana użytkowników |
|
Pełna nazwa
|
fullName | string |
Imię i nazwisko użytkownika |
|
Imię
|
firstName | string |
Imię i nazwisko użytkowników |
|
Nazwisko
|
lastName | string |
Nazwisko użytkowników |
|
displayNameFormat
|
displayNameFormat | string | |
|
stan
|
status | string | |
|
Ukończono profil
|
profileCompleted | boolean |
Czy profil użytkowników został ukończony podczas dołączania |
|
Data ostatniego działania
|
lastActivityDate | date-time |
Ostatni raz użytkownik wchodził w interakcję z systemem. |
|
Title
|
title | string |
Tytuł użytkowników |
|
Lokalizacja
|
location | string |
Samodzielnie opisana lokalizacja użytkowników (może nie być rzeczywistą lokalizacją geograficzną) |
|
Identyfikator użytkownika interfejsu API zewnętrznego
|
externalApiUserId | string |
Identyfikator użytkowników w systemie zewnętrznym zarządzanym przez obiekt wywołujący tego interfejsu API |
|
Identyfikator użytkownika menedżera
|
managerUserId | integer |
Identyfikator menedżera użytkowników (dla funkcji hierarchii organizacyjnej) |
|
Strefa czasowa
|
timeZone | string |
Strefa czasowa użytkownika reprezentowana jako nazwa strefy czasowej bazy danych tz ustawiona przez IANA. Przykład: "Ameryka/Los_Angeles". |
|
Wybrana strefa czasowa
|
selectedTimeZone | string |
Użytkownicy wybrali strefę czasową reprezentowaną jako nazwa strefy czasowej bazy danych tz ustawioną przez IANA. Przykład: "Ameryka/Los_Angeles". |
|
Saldo punktów
|
pointBalance | integer |
Łączna liczba punktów uzyskanych do tej pory |
|
Punkty bezredeemowane
|
unredeemedPoints | integer |
Punkty, które są obecnie dostępne do realizacji |
|
Zrealizowane punkty
|
redeemedPoints | integer |
Liczba punktów zrealizowanych w okresie istnienia użytkowników |
|
Informacje o interfejsie API
|
apiInfo | string |
Torba właściwości specyficzna dla interfejsu API |
|
Ma hasło
|
hasPassword | boolean |
Czy użytkownik ma hasło skojarzone z kontem. |
|
Musi zmienić hasło
|
mustChangePassword | boolean |
Czy użytkownik musi zmienić swoje hasło na podstawie ustawień społeczności |
|
Czy konto zostało zweryfikowane
|
isAccountVerified | boolean |
Wskazuje, czy użytkownik zweryfikował swój adres e-mail |
|
|
statistics | postStatisticsResponse | |
|
tags
|
tags | object | |
|
Odznaki
|
badges | object | |
|
Przynależności
|
affiliations | array of userAffiliationResponse | |
|
Podziałów
|
divisions | array of divisionResponse | |
|
Kanały
|
channels | array of userChannelResponse | |
|
profilePictureImages
|
profilePictureImages | object | |
|
Języki
|
languages | array of string | |
|
Język podstawowy
|
primaryLanguage | string |
Podstawowy język interfejsu użytkowników |
|
|
scheduleSettings | userScheduleSettingsResponse |
Preferencje dotyczące zaplanowanego udostępniania użytkowników |
|
Czy logowanie jednokrotne
|
isSso | boolean |
Czy użytkownik jest skonfigurowany do uwierzytelniania przy użyciu logowania jednokrotnego |
|
|
permissions | userPermissionsResponse |
Uprawnienia menedżerów |
|
|
privileges | userPrivilegesResponse |
Uprawnienia użytkowników |
|
Identyfikatory
|
identifiers | array of allowlistIdentifiersResponse | |
|
targets
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
Kolekcja wartości domyślnych użytkowników |
|
Baner powitalny odrzucony
|
welcomeBannerDismissed | boolean |
Czy użytkownik odrzucił baner powitalny |
userDefaultsRequestResponse
Kolekcja wartości domyślnych użytkowników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
defaultPostState
|
defaultPostState | string | |
|
defaultPostApprovalState
|
defaultPostApprovalState | string | |
|
Domyślny wpis— pokaż dyskusje wewnętrzne
|
defaultPostShowInternalDiscussions | boolean |
Użytkownicy domyślnie publikują stan dyskusji wewnętrznych podczas tworzenia wpisu |
|
Domyślny wpis pokaż informacje o twórcy
|
defaultPostShowCreatorInfo | boolean |
Domyślny stan użytkowników podczas tworzenia wpisu dotyczącego wyświetlania nazwy twórcy i zdjęcia |
allowlistIdentifiersResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator definicji listy dozwolonych |
|
Wartość
|
value | string |
Odpowiedź użytkowników dla podanej definicji listy dozwolonych |
userPrivilegesResponse
Uprawnienia użytkowników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Może przesyłać wpisy
|
canSubmitPosts | boolean |
Wskazuje, czy użytkownik ma możliwość przesyłania wpisów na podstawie swoich uprawnień i ustawień społeczności |
|
Może udostępniać wpisy
|
canSharePosts | boolean |
Wskazuje, czy użytkownik ma możliwość udostępniania wpisów na podstawie swoich uprawnień i ustawień społeczności |
|
Może komentować wpisy
|
canCommentPosts | boolean |
Wskazuje, czy użytkownik ma możliwość komentowania i polubień wpisów na podstawie ich uprawnień i ustawień społeczności |
|
Może zarządzać społecznością
|
canManageCommunity | boolean |
Wskazuje, czy użytkownik jest menedżerem w społeczności, na podstawie ich uprawnień i ustawień społeczności |
|
Może zarządzać organizacją
|
canManageOrganization | boolean |
Wskazuje, czy użytkownik ma możliwość komunikowania się z raportami bezpośrednimi i pośrednimi w społeczności na podstawie ich uprawnień i ustawień społeczności |
|
Może ustawić opcję Po udostępnieniu
|
canSetPostShareable | boolean |
Czy użytkownik może ustawić stan Udostępnianie podczas przesyłania wpisu |
userPermissionsResponse
Uprawnienia menedżerów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wyświetl emisję
|
viewBroadcast | boolean |
Umożliwia menedżerowi wyświetlanie emisji |
|
Emisja listy
|
listBroadcast | boolean |
Umożliwia menedżerowi wyświetlanie list emisji |
|
Edytuj emisję
|
editBroadcast | boolean |
Umożliwia menedżerowi tworzenie i edytowanie emisji |
|
Wyświetlanie statystyk emisji
|
viewBroadcastStats | boolean |
Umożliwia menedżerowi wyświetlanie statystyk emisji |
|
Wyświetl wpis
|
viewPost | boolean |
Umożliwia menedżerowi wyświetlanie wpisów |
|
Wpis na liście
|
listPost | boolean |
Umożliwia menedżerowi wyświetlanie list wpisów |
|
Edytuj wpis
|
editPost | boolean |
Umożliwia menedżerowi tworzenie i edytowanie wpisów |
|
Wyświetlanie statystyk po wpisie
|
viewPostStats | boolean |
Umożliwia menedżerowi wyświetlanie statystyk |
|
Wyświetl ankietę
|
viewSurvey | boolean |
Umożliwia menedżerowi wyświetlanie ankiet |
|
Ankieta listy
|
listSurvey | boolean |
Umożliwia menedżerowi wyświetlanie list ankiet |
|
Edytuj ankietę
|
editSurvey | boolean |
Umożliwia menedżerowi tworzenie i edytowanie ankiet |
|
Ustawienia społeczności
|
communitySettings | boolean |
Umożliwia menedżerowi wyświetlanie i edytowanie ustawień społeczności |
userScheduleSettingsResponse
Preferencje dotyczące zaplanowanego udostępniania użytkowników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dni
|
days | string | |
|
razy
|
times | array of string |
userChannelResponse
Kanał użytkownika.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator kanału użytkownika
|
userChannelId | integer |
Identyfikator wewnętrznego kanału użytkownika |
|
Identyfikator użytkownika
|
userId | integer |
Identyfikator użytkownika wewnętrznego |
|
dostawca
|
provider | string | |
|
Name
|
name | string |
Nazwa użytkowników u dostawcy społecznościowego |
|
Wyświetlana nazwa
|
displayName | string |
Nazwa wyświetlana użytkowników u dostawcy społecznościowego |
|
Identyfikator użytkownika dostawcy
|
providerUserId | string |
Identyfikator użytkownika dostawcy |
|
stan
|
status | string | |
|
URL
|
url | string |
Adres URL kanału |
|
Znajomi
|
friends | integer |
Liczba znajomych, które użytkownik ma w kanale |
|
Followers
|
followers | integer |
Liczba obserwujących użytkowników w kanale |
|
Following
|
following | integer |
Liczba osób, które użytkownik obserwuje w kanale |
|
Posty
|
posts | integer |
Liczba wpisów, które użytkownik opublikował w kanale. |
|
Views
|
views | integer |
Liczba wyświetleń, które użytkownik ma w kanale |
|
Saldo punktów
|
pointBalance | integer |
Saldo punktów użytkownika w kanale |
|
Nazwa wyświetlana źródła
|
sourceDisplayName | string |
Nazwa wyświetlana kanału użytkownika, gdy jest używana jako źródło zawartości |
|
Zasięg
|
reach | integer |
Użytkownicy uzyskują dostęp do kanału |
|
Sharable
|
sharable | boolean |
Czy kanał obsługuje udostępnianie |
|
Udostępnianie domyślne
|
sharingDefault | boolean |
Czy kanał jest wstępnie wybrany do udostępniania |
|
Wymagane uwierzytelnianie
|
authRequired | boolean |
Czy poświadczenia kanałów muszą zostać odnowione |
|
|
statistics | postStatisticsResponse | |
|
profilePictureImages
|
profilePictureImages | object |
divisionResponse
Definicja dzielenia
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dzielenia
|
divisionId | integer |
Identyfikator dzielenia |
|
Name
|
name | string |
Nazwa dzielenia |
|
Identyfikator podziału nadrzędnego
|
parentDivisionId | integer |
Identyfikator tego elementu nadrzędnego dzielenia |
userAffiliationResponse
Przynależność użytkownika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
Pytanie dotyczące przynależności |
|
|
answer | affiliationAnswerResponse |
Odpowiedź na przynależność |
affiliationAnswerResponse
Odpowiedź na przynależność
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator odpowiedzi
|
answerId | integer |
Identyfikator odpowiedzi |
|
Odpowiedź
|
answer | string |
Odpowiedź |
|
Score
|
score | double |
Wynik, jeśli zostanie podany |
|
Dowolny tekst
|
freeText | string |
Tekst pytań z typem pytania freetext |
|
Odrzuć odpowiedź
|
declineToAnswer | boolean |
W przypadku ustawienia jest to odpowiedź, która oznacza, że użytkownik odmówił odpowiedzi na pytanie. |
|
Position
|
position | integer |
Pozycja sortowania odpowiedzi |
affiliationQuestionResponse
Pytanie dotyczące przynależności
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator pytania
|
questionId | integer |
Identyfikator pytania |
|
Name
|
name | string |
Pytanie |
|
Pozycja oceny
|
scorePosition | integer |
Pytania dotyczące pozycji sortowania |
|
Description
|
description | string |
Opis pytań |
|
questionType
|
questionType | string | |
|
Wymagane
|
required | boolean |
Czy należy odpowiedzieć na pytanie, aby się zarejestrować |
|
Jest widoczny publicznie
|
isPubliclyVisible | boolean |
documentInfoResponse
Informacje istotne dla dołączonego dokumentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | uuid |
Identyfikator dokumentów |
|
Nazwa pliku
|
fileName | string |
Nazwa pliku dokumentów (z rozszerzeniem) |
|
Extension
|
extension | string |
Rozszerzenie pliku dokumentów |
|
Typ mime
|
mimeType | string |
Typ MIME dokumentów |
divisionsResponse
Podziały zdefiniowane w systemie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Podziałów
|
divisions | array of divisionResponse | |
|
Podpowiedź
|
prompt | string |
Etykieta monitowania członków o wybranie dzielenia |
|
Pokaż wybór działu użytkowników
|
showUserDivisionSelection | boolean |
Czy zarejestrowani członkowie mogą zmienić własny podział |
|
Pokaż wybór działu użytkowników podczas dołączania
|
showUserDivisionSelectionDuringOnboarding | boolean |
Czy nowi członkowie powinni wybrać własny podział podczas rejestracji |
|
Wymagaj wyboru dzielenia użytkowników
|
requireUserDivisionSelection | boolean |
Czy członkowie muszą wybrać własny podział. |
|
Zezwalaj na wiele podziałów
|
allowMultipleDivisions | boolean |
Czy członkowie mogą wybrać wiele lub tylko jeden podział |
categoryResponse1
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator kategorii |
|
Name
|
name | string |
Nazwa kategorii |
|
Description
|
description | string |
Opis kategorii |
|
Kolejność wyświetlania
|
displayOrder | integer |
Kolejność wyświetlania kategorii |
|
Jest przypięty
|
isPinned | boolean |
Czy kategoria została przypięta przez administratora |
|
Jest wymuszone
|
isForced | boolean |
Czy uwierzytelniony użytkownik jest wymusić subskrybowanie danej kategorii |
|
Jest subskrybowany
|
isSubscribed | boolean |
Wther uwierzytelniony użytkownik jest subskrybowany do danej kategorii |
|
Jest ukryty
|
isHidden | boolean |
Czy kategoria jest ukryta przez administratora |
|
Czy użytkownik może wybrać
|
isUserSelectable | boolean |
Czy użytkownicy mogą wybierać kategorie dla przesłanych wpisów |
|
Identyfikator kategorii nadrzędnej
|
parentCategoryId | integer |
Identyfikator kategorii nadrzędnej |
targetInfoResponse1
Szczegółowe informacje dotyczące określonego celu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator docelowy |
|
Name
|
name | string |
Nazwa obiektu docelowego |
|
Description
|
description | string |
Cele descritption |
|
Identyfikator definicji
|
definitionId | integer |
Identyfikator definicji docelowej, do którego należy element docelowy |
|
Identyfikator nadrzędny
|
parentId | integer |
Identyfikator obiektu nadrzędnego obiektów docelowych, jeśli ma jeden |
|
Jest subskrybowany
|
isSubscribed | boolean |
Czy użytkownik jest subskrybowany do określonego miejsca docelowego |
|
childTargets
|
childTargets | array of targetInfoResponse2 |
targetInfoResponse2
Szczegółowe informacje dotyczące określonego celu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator docelowy |
|
Name
|
name | string |
Nazwa obiektu docelowego |
|
Description
|
description | string |
Cele descritption |
|
Identyfikator definicji
|
definitionId | integer |
Identyfikator definicji docelowej, do którego należy element docelowy |
|
Identyfikator nadrzędny
|
parentId | integer |
Identyfikator obiektu nadrzędnego obiektów docelowych, jeśli ma jeden |
|
Jest subskrybowany
|
isSubscribed | boolean |
Czy użytkownik jest subskrybowany do określonego miejsca docelowego |
|
childTargets
|
childTargets | array of targetInfoResponse3 |
targetInfoResponse3
Szczegółowe informacje dotyczące określonego celu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator docelowy |
|
Name
|
name | string |
Nazwa obiektu docelowego |
|
Description
|
description | string |
Cele descritption |
|
Identyfikator definicji
|
definitionId | integer |
Identyfikator definicji docelowej, do którego należy element docelowy |
|
Identyfikator nadrzędny
|
parentId | integer |
Identyfikator obiektu nadrzędnego obiektów docelowych, jeśli ma jeden |
|
Jest subskrybowany
|
isSubscribed | boolean |
Czy użytkownik jest subskrybowany do określonego miejsca docelowego |