Udostępnij przez


Survalyzer EU (wersja zapoznawcza)

Łącznik Survalyzer zapewnia uproszczony dostęp do wszystkich funkcji interfejsu API centrum danych UE.

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 Survalyzer Developer Center
adres URL https://developer.survalyzer.com/
Metadane łącznika
Publisher Survalyzer AG
Witryna internetowa https://survalyzer.com
Zasady ochrony prywatności https://survalyzer.com/privacy-policy
Kategorie Marketing; Produktywność

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
Identyfikator klienta — Identyfikator klienta Survalyzer ClientId ciąg Wprowadź identyfikator klienta. Prawda
Klucz tajny klienta — Twój survalyzer ClientSecret securestring Wprowadź klucz tajny klienta. Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie ankiety

Ta akcja umożliwia zaktualizowanie ankiety.

Aktualizowanie elementu Web Hook

Ta akcja umożliwia zaktualizowanie elementu webhook.

Aktualizowanie elementów członkowskich

Ta akcja umożliwia zaktualizowanie listy elementów członkowskich.

Aktualizowanie Opt-Outs

Ta akcja umożliwia zapisanie wpisów na liście Opt-Out dla obszaru roboczego.

Czytaj dystrybutorów

Ta akcja umożliwia odczytanie listy dystrybutorów.

Odczyt Opt-Outs

Ta akcja umożliwia odczytanie wszystkich Opt-Outs dla obszaru roboczego.

Odczyt salda środków

Ta akcja zwraca saldo środków ankiety dla uwierzytelnioowanego użytkownika.

Odczytaj odbicia

Ta akcja umożliwia odczytanie listy odbijania.

Odczytywanie artefaktów

Ta akcja umożliwia odczytanie listy artefaktów.

Odczytywanie członków

Ta akcja umożliwia odczytywanie członków.

Odczytywanie elementów webhook

Ta akcja umożliwia odczytanie listy elementów webhook.

Odczytywanie linków do ankiety

Ta akcja umożliwia odczytanie linków do ankiety.

Odczytywanie obszarów roboczych

Ta akcja umożliwia odczytywanie wszystkich dostępnych obszarów roboczych.

Odczytywanie projektu próbkowania

Ta akcja umożliwia odczytanie projektu próbkowania.

Odczytywanie przejść przepływu pracy

Ta akcja umożliwia odczytywanie wszystkich przejść przepływu pracy specyficznych dla przepływu pracy.

Odczytywanie szablonów wiadomości

Ta akcja umożliwia odbieranie wszystkich skonfigurowanych szablonów wiadomości e-mail i wiadomości SMS.

Odczytywanie transakcji zachęt

Akcja zwraca przegląd wszystkich zarobków i wydatków związanych z kredytami ankietowym.

Panel aktualizacji

Ta akcja umożliwia zaktualizowanie panelu.

Panel odczytu

Ta akcja umożliwia odczytywanie definicji panelu.

Pobierz plik PDF z wywiadem

Ta akcja umożliwia pobranie odpowiedzi.

Przeczytaj ankiety

Ta akcja umożliwia odczytanie wszystkich dostępnych ankiet danego obszaru roboczego.

Przeczytaj ankietę

Ta akcja umożliwia przeczytanie ankiety.

Przeczytaj wywiad

Ta akcja umożliwia odczytanie danych wywiadowych.

Przeczytaj wywiady

Ta akcja umożliwia przeczytanie listy wywiadów.

Przeczytaj wywiady Compact

Ta akcja umożliwia przeczytanie listy wywiadów compact.

Przeczytaj zachęty

Ta akcja zwraca dostępne zachęty/kupon dla uwierzytelnioowanego użytkownika.

Przypominanie członkom

Ta akcja umożliwia przypomnienie członkowi.

Resetuj wywiad

Ta akcja umożliwia zresetowanie odpowiedzi członka panelu.

Tworzenie ankiety

Ta akcja umożliwia utworzenie ankiety.

Tworzenie artefaktu

Ta akcja umożliwia utworzenie nowego artefaktu.

Tworzenie członków

Ta akcja umożliwia utworzenie listy elementów członkowskich.

Tworzenie elementu webhook

Ta akcja umożliwia utworzenie elementu webhook.

Tworzenie panelu lub przykładu

Ta akcja umożliwia utworzenie nowego panelu.

Usuwanie elementu webhook

Ta akcja umożliwia usunięcie elementu webhook.

Usuwanie projektu próbkowania

Ta akcja umożliwia usunięcie projektu próbkowania.

Usuń ankietę

Ta akcja umożliwia usunięcie ankiety.

Usuń artefakt

Ta akcja umożliwia usunięcie artefaktu.

Usuń członków

Ta akcja umożliwia usunięcie członków.

Usuń dystrybutora

Ta akcja umożliwia usunięcie dystrybutora.

Usuń panel

Ta akcja umożliwia usunięcie panelu.

Usuń wywiad

Ta akcja umożliwia usunięcie wywiadu.

Wykonywanie przejścia przepływu pracy

Ta akcja umożliwia wykonanie przejścia przepływu pracy specyficznego dla przepływu pracy.

Wyślij wiadomość e-mail

Ta akcja umożliwia wysyłanie wiadomości e-mail.

Zaproś członków

Ta akcja umożliwia zaproszenie członka.

Zaproś członków

Ta akcja umożliwia tworzenie i zapraszanie członków.

Zrealizuj kod zachęty

Ta akcja umożliwia wydawanie środków ankietowych na zachęty/bony.

Aktualizowanie ankiety

Ta akcja umożliwia zaktualizowanie ankiety.

Parametry

Nazwa Klucz Wymagane Typ Opis
surveyId
surveyId True integer

Pobiera lub ustawia identyfikator ankiety.

surveyName
surveyName string

Pobiera lub ustawia nazwę ankiety.

allowMultipleParticipation
allowMultipleParticipation True boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na wielokrotne uczestnictwo].

allowNavigateBack
allowNavigateBack True boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na przechodzenie z powrotem].

allowSaveProgress
allowSaveProgress boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na postęp zapisywania].

randomizeSections
randomizeSections True boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe sekcje].

enableAutoScroll
enableAutoScroll boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz automatyczne przewijanie].

enableCodeAccess
enableCodeAccess boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz dostęp do kodu].

accessType (typ dostępu)
accessType string

Typ dostępu

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

associatedPanels
associatedPanels array of integer

Pobiera lub ustawia identyfikator panelu.

codeAccessMode
codeAccessMode True string

Typ uwierzytelniania

enablePanelSync
enablePanelSync boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz synchronizację panelu].

panelSyncBehaviour
panelSyncBehaviour string

PanelSyncBehaviour

identyfikator
identifier string

Pobiera lub ustawia identyfikator.

panelPole
panelField string

Pobiera lub ustawia pole panelu.

defaultLanguage (język domyślny)
defaultLanguage True string

Pobiera lub ustawia język domyślny.

data zakończenia
endDate date-time

Pobiera lub ustawia datę zakończenia.

Języki
languages True array of string

Pobiera lub ustawia języki.

id
id True integer

Pobiera lub ustawia identyfikator.

nazwa
name True string

Pobiera lub ustawia nazwę.

randomizePages
randomizePages True boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe strony].

excludeFromRandomization
excludeFromRandomization True boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

id
id True integer

Pobiera lub ustawia identyfikator.

elementType
elementType True string

Typ elementu

kod
code string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

languageCode
languageCode True string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

hasHintText
hasHintText boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma tekst wskazówek.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie nie ma dostępnego wyboru.

forceResponse
forceResponse boolean

Pobiera lub ustawia wartość wskazującą, czy [wymuś odpowiedź].

id
id True integer

Pobiera lub ustawia identyfikator.

kod
code True string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

allowTextEntry
allowTextEntry True boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na wpis tekstowy].

forceInput
forceInput True boolean

Pobiera lub ustawia wartość wskazującą, czy [wymuś wejście].

autouzupełnianie
autocomplete True boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.Choice jest autouzupełnianie.

wyłączny
exclusive True boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.Choice jest wyłączny.

excludeFromRandomization
excludeFromRandomization boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

validationType
validationType True string

Walidacja zawartości

najwcześniejsza
earliestDate string

Pobiera lub ustawia najwcześniejszą datę.

latestDate
latestDate string

Pobiera lub ustawia najnowszą datę.

minValue (wartość minimalna)
minValue double

Pobiera lub ustawia minimalną wartość.

maxValue (maksymalna wartość)
maxValue double

Pobiera lub ustawia maksymalną wartość.

liczba miejsc dziesiętnych
decimalPlaces integer

Pobiera lub ustawia miejsca dziesiętne.

disableThousandSeparator
disableThousandSeparator boolean

Pobiera lub ustawia separator tysięcy wyłącz.

conditionAction
conditionAction True string

Filtrowanie

autouzupełnianieListVariable
autocompleteListVariable string

Pobiera lub ustawia zmienną listy autouzupełniania.

randomizeChoices
randomizeChoices boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe wybory].

columnType
columnType string

Typ kolumny

minValue (wartość minimalna)
minValue integer

Pobiera lub ustawia minimalną wartość.

maxValue (maksymalna wartość)
maxValue integer

Pobiera lub ustawia maksymalną wartość.

showCenterLabel
showCenterLabel boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż etykietę środkową].

showValue
showValue boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż wartość].

maxDecimals
maxDecimals integer

Pobiera lub ustawia maksymalną liczbę cyfr po przecinkach.

textFieldSize
textFieldSize string

TextFieldSize

autouzupełnianie
autocomplete boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.SurveyElement jest autouzupełnianie.

hasPlaceholder
hasPlaceholder boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma symbol zastępczy.

isPassword
isPassword boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest hasłem.

minMaxValidation
minMaxValidation boolean

Pobiera lub ustawia wartość wskazującą, czy [minimalna maksymalna weryfikacja].

minimumCheckedChoices
minimumCheckedChoices integer

Pobiera lub ustawia minimalne zaznaczone opcje.

maximumCheckedChoices
maximumCheckedChoices integer

Pobiera lub ustawia maksymalnie zaznaczone opcje.

id
id True integer

Pobiera lub ustawia identyfikator.

hasNotAvailableChoice
hasNotAvailableChoice True boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie nie ma dostępnego wyboru.

randomizeColumns
randomizeColumns True boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe kolumny].

choiceType
choiceType True string

ChoiceType

randomizeRows
randomizeRows boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe wiersze].

id
id True integer

Pobiera lub ustawia identyfikator.

kod
code True string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

excludeFromRandomization
excludeFromRandomization True boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

numberOfRanks
numberOfRanks integer

Pobiera lub ustawia liczbę klasyfikacji.

hasStartText
hasStartText boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma tekst początkowy.

enableMeasurement
enableMeasurement boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz pomiar].

showButtons
showButtons boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż przyciski].

likeKey
likeKey string

Pobiera lub ustawia klucz podobny.

nie lubię klawiszaKey
dislikeKey string

Pobiera lub ustawia nie lubi klucza.

interviewState
interviewState string

Pobiera lub ustawia stan odpowiedzi.

actionType
actionType True string

Limit przydziału

z
from string

Pobiera lub ustawia nadawcę.

na
to string

Pobiera lub ustawia odbiornik.

valueAssignmentType
valueAssignmentType string

ValueAssignmentType

variableName
variableName string

Pobiera lub ustawia nazwę zmiennej.

executionBehavior
executionBehavior string

WykonanieBehavior

apiCallMethod
apiCallMethod string

ApiCallMethod

headers
headers string

Pobiera lub ustawia nagłówki.

externalUri
externalUri string

Pobiera lub ustawia zewnętrzny identyfikator URI.

scriptType
scriptType string

Typ skryptu

zawartość
content string

Pobiera lub ustawia zawartość.

hasRatingLabels
hasRatingLabels boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma etykiety klasyfikacji.

evaluateAsJson
evaluateAsJson boolean

Pobiera lub ustawia wartość wskazującą, czy [oceń jako json].

autouzupełnianieListVariable
autocompleteListVariable string

Pobiera lub ustawia zmienną listy autouzupełniania.

arrangementMode
arrangementMode string

Tryb rozmieszczenia

enableAnimation
enableAnimation boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz animację].

useSmiley
useSmiley boolean

Pobiera lub ustawia wartość wskazującą, czy [użyj buźki].

hasPrompt
hasPrompt boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma monit.

id
id True integer

Pobiera lub ustawia identyfikator.

variableName
variableName True string

Pobiera lub ustawia nazwę zmiennej.

defaultTextOverrides
defaultTextOverrides object

Pobiera lub ustawia domyślne przesłonięcia tekstu.

surveyDesignLayout
surveyDesignLayout integer

Pobiera lub ustawia układ projektu ankiety.

matrixSubQuestionSize
matrixSubQuestionSize string

MatrixSubQuestionSize

nazwa
name string

Pobiera lub ustawia nazwę.

typ
type string

Pobiera lub ustawia typ.

languageCode
languageCode True string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

anonimizowanieMode
anonymizingMode True string

Tryb anonimowości

logIp
logIp True boolean

Pobiera lub ustawia wartość wskazującą, czy [log ip].

logUserAgent
logUserAgent True boolean

Pobiera lub ustawia wartość wskazującą, czy [log user agent].

logReferer
logReferer True boolean

Pobiera lub ustawia wartość wskazującą, czy [referer dziennika].

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API UpdateSurvey.

Aktualizowanie elementu Web Hook

Ta akcja umożliwia zaktualizowanie elementu webhook.

Parametry

Nazwa Klucz Wymagane Typ Opis
webHookId
webHookId uuid

Pobiera lub ustawia identyfikator elementu webhook.

eventType
eventType string

Typ Wydarzenia

entityIdentifier
entityIdentifier string

Pobiera lub ustawia identyfikator jednostki.

securityToken
securityToken string

Pobiera lub ustawia token zabezpieczający.

webHookUrl (adres URL elementu webHook)
webHookUrl string

Pobiera lub ustawia adres URL elementu webhook.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateWebHook.

Aktualizowanie elementów członkowskich

Ta akcja umożliwia zaktualizowanie listy elementów członkowskich.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant string

Pobiera lub ustawia dzierżawę.

panelId
panelId True integer

Pobiera lub ustawia identyfikator panelu.

id
id integer

Pobiera lub ustawia identyfikator.

pola
fields True object

Pobiera lub ustawia pola.

createdAt
createdAt date-time

Pobiera lub ustawia utworzony element.

utworzone przez
createdBy string

Pobiera lub ustawia utworzone przez.

updatedAt
updatedAt date-time

Pobiera lub ustawia zaktualizowaną wartość.

zaktualizowanoPrzez
updatedBy string

Pobiera lub ustawia zaktualizowane przez.

id
id string

Identyfikator wywiadu

stan
state string

Pobiera lub ustawia stan.

surveyId
surveyId integer

Identyfikator ankiety

surveyVersionId
surveyVersionId integer

Identyfikator wersji ankiety

surveyName
surveyName string

Nazwa ankiety

surveyState
surveyState string

Pobiera lub ustawia stan ankiety.

answersLink
answersLink string

Link do strony wydruku odpowiedzi

interviewLink
interviewLink string

Pobiera lub ustawia link wywiadu.

startDate
startDate string

Pobiera lub ustawia datę rozpoczęcia.

data zakończenia
endDate string

Pobiera lub ustawia datę zakończenia.

samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API UpdateMembers.

Aktualizowanie Opt-Outs

Ta akcja umożliwia zapisanie wpisów na liście Opt-Out dla obszaru roboczego.

Parametry

Nazwa Klucz Wymagane Typ Opis
workspaceId
workspaceId integer

Pobiera lub ustawia identyfikator obszaru roboczego.

panelId
panelId integer

Pobiera lub ustawia identyfikator panelu.

identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

e-mail
email True string

Pobiera lub ustawia wiadomość e-mail.

optOutOperation
optOutOperation True string

OptOutOperation

telefon komórkowy
cellPhone True integer

Pobiera lub ustawia telefon komórkowy.

optOutOperation
optOutOperation True string

OptOutOperation

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API WriteOptOutList.

Czytaj dystrybutorów

Ta akcja umożliwia odczytanie listy dystrybutorów.

Parametry

Nazwa Klucz Wymagane Typ Opis
surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

panelId
panelId integer

Pobiera lub ustawia identyfikator panelu.

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadDistributorList.

Odczyt Opt-Outs

Ta akcja umożliwia odczytanie wszystkich Opt-Outs dla obszaru roboczego.

Parametry

Nazwa Klucz Wymagane Typ Opis
panelId
panelId integer

Pobiera lub ustawia identyfikator panelu.

workspaceId
workspaceId integer

Pobiera lub ustawia identyfikator obszaru roboczego.

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadOptOutList.

Odczyt salda środków

Ta akcja zwraca saldo środków ankiety dla uwierzytelnioowanego użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
object

Ta klasa reprezentuje parametry żądania dla interfejsu API ReadCreditBalance.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadCreditBalance.

Odczytaj odbicia

Ta akcja umożliwia odczytanie listy odbijania.

Parametry

Nazwa Klucz Wymagane Typ Opis
surveyId
surveyId True integer

Pobiera lub ustawia identyfikator ankiety.

panelId
panelId integer

Pobiera lub ustawia identyfikator panelu.

Dystrybutorów
distributors array of integer

Pobiera lub ustawia dystrybutorów.

invitationType
invitationType string

Typ zaproszenia

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadBounceList.

Odczytywanie artefaktów

Ta akcja umożliwia odczytanie listy artefaktów.

Parametry

Nazwa Klucz Wymagane Typ Opis
ścieżka
path string

Pobiera lub ustawia ścieżkę.

workspaceId
workspaceId integer

Pobiera lub ustawia identyfikator obszaru roboczego.

Zwraca

Ta klasa reprezentuje parametry żądania interfejsu API ReadArtifactList.

Odczytywanie członków

Ta akcja umożliwia odczytywanie członków.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant string

Pobiera lub ustawia dzierżawę.

panelId
panelId True integer

Pobiera lub ustawia identyfikator panelu.

wywiadyWymagane
interviewsRequired True boolean

Pobiera lub ustawia wartość wskazującą, czy informacje o sesji są wymagane.

fieldsToDownload
fieldsToDownload array of string

Pobiera lub ustawia pola do pobrania.

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadMemberList.

Odczytywanie elementów webhook

Ta akcja umożliwia odczytanie listy elementów webhook.

Parametry

Nazwa Klucz Wymagane Typ Opis
eventType
eventType string

Typ Wydarzenia

entityIdentifier
entityIdentifier string

Pobiera lub ustawia identyfikator jednostki.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadWebHookList.

Odczytywanie linków do ankiety

Ta akcja umożliwia odczytanie linków do ankiety.

Parametry

Nazwa Klucz Wymagane Typ Opis
surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

Zwraca

Ta klasa reprezentuje odpowiedź interfejsu API ReadSurveyLinks.

Odczytywanie obszarów roboczych

Ta akcja umożliwia odczytywanie wszystkich dostępnych obszarów roboczych.

Parametry

Nazwa Klucz Wymagane Typ Opis
koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry żądania dla interfejsu API ReadWorkspaceList.

Odczytywanie projektu próbkowania

Ta akcja umożliwia odczytanie projektu próbkowania.

Parametry

Nazwa Klucz Wymagane Typ Opis
samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadSamplingProject.

Odczytywanie przejść przepływu pracy

Ta akcja umożliwia odczytywanie wszystkich przejść przepływu pracy specyficznych dla przepływu pracy.

Parametry

Nazwa Klucz Wymagane Typ Opis
przepływ pracy
workflow True string

Typ przepływu pracy

currentState
currentState True string

Pobiera lub ustawia stan bieżącego.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadWorkflowTransitions.

Odczytywanie szablonów wiadomości

Ta akcja umożliwia odbieranie wszystkich skonfigurowanych szablonów wiadomości e-mail i wiadomości SMS.

Parametry

Nazwa Klucz Wymagane Typ Opis
workspaceId
workspaceId integer

Pobiera lub ustawia identyfikator obszaru roboczego.

język
language True string

Pobiera lub ustawia język.

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadMessageTemplateList.

Odczytywanie transakcji zachęt

Akcja zwraca przegląd wszystkich zarobków i wydatków związanych z kredytami ankietowym.

Parametry

Nazwa Klucz Wymagane Typ Opis
koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadIncentiveTransactionList.

Panel aktualizacji

Ta akcja umożliwia zaktualizowanie panelu.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant string

Pobiera lub ustawia dzierżawę.

panelId
panelId True integer

Pobiera lub ustawia identyfikator panelu.

id
id integer

Identyfikator pola. Jest to pole obowiązkowe w przypadku zmiany nazwy.

nazwa
name string

Nazwa pola. To pole jest obowiązkowe.

typ
type string

PanelMemberFieldType

value
value

Wartość pola. Typ wartości musi być zgodny z właściwością Type.

removedFields
removedFields array of integer

Pobiera lub ustawia usunięte pola.

id
id integer

Identyfikator pola. Jest to pole obowiązkowe w przypadku zmiany nazwy.

nazwa
name string

Nazwa pola. To pole jest obowiązkowe.

typ
type string

PanelMemberFieldType

value
value

Wartość pola. Typ wartości musi być zgodny z właściwością Type.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API WritePanel.

Panel odczytu

Ta akcja umożliwia odczytywanie definicji panelu.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant string

Pobiera lub ustawia dzierżawę.

panelId
panelId True integer

Pobiera lub ustawia identyfikator panelu.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadPanelDefinition.

Pobierz plik PDF z wywiadem

Ta akcja umożliwia pobranie odpowiedzi.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tenant
tenant True string

Dzierżawa.

Identyfikator ankiety
surveyId True integer

Identyfikator ankiety.

Identyfikator wywiadu
interviewId True uuid

Identyfikator wywiadu.

Pokaż częściowe ukończone
showPartialCompleted boolean

jeśli ustawiono <wartość c>true</c> [pokaż częściowe ukończone].

Lokalizacja
locale string

Ustawienia regionalne.

Thmezone
timeZone string

Strefa czasowa.

isCancellationRequested
isCancellationRequested boolean
canBeCanceled
canBeCanceled boolean
isInvalid
isInvalid boolean
isClosed
isClosed boolean

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DownloadAnswers.

Przeczytaj ankiety

Ta akcja umożliwia odczytanie wszystkich dostępnych ankiet danego obszaru roboczego.

Parametry

Nazwa Klucz Wymagane Typ Opis
workspaceId
workspaceId True integer

Pobiera lub ustawia identyfikator obszaru roboczego.

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry odpowiedzi interfejsu API ReadSurveyList.

Przeczytaj ankietę

Ta akcja umożliwia przeczytanie ankiety.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant string

Pobiera lub ustawia dzierżawę.

surveyId
surveyId True integer

Pobiera lub ustawia identyfikator ankiety.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadSurveyDefinition.

Przeczytaj wywiad

Ta akcja umożliwia odczytanie danych wywiadowych.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant True string

Pobiera lub ustawia dzierżawę.

identyfikator wywiadu
interviewId True uuid

Pobiera lub ustawia identyfikator wywiadu.

surveyId
surveyId True integer

Pobiera lub ustawia identyfikator ankiety.

loadSurveyDefinition
loadSurveyDefinition boolean

Pobiera lub ustawia wartość wskazującą, czy [ładowanie definicji ankiety].

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadInterviewData.

Przeczytaj wywiady

Ta akcja umożliwia przeczytanie listy wywiadów.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant string

Pobiera lub ustawia dzierżawę.

surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

fieldsToDownload
fieldsToDownload array of string

Pobiera lub ustawia żądane kolumny.

loadCodePlan
loadCodePlan boolean

Pobiera lub ustawia wartość wskazującą, czy [załaduj plan kodu].

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadInterviewList.

Przeczytaj wywiady Compact

Ta akcja umożliwia przeczytanie listy wywiadów compact.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant string

Pobiera lub ustawia dzierżawę.

surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

fieldsToDownload
fieldsToDownload array of string

Pobiera lub ustawia żądane kolumny.

loadCodePlan
loadCodePlan boolean

Pobiera lub ustawia wartość wskazującą, czy [załaduj plan kodu].

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadInterviewListCompact.

Przeczytaj zachęty

Ta akcja zwraca dostępne zachęty/kupon dla uwierzytelnioowanego użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

pageSize
pageSize True integer

Pobiera lub ustawia rozmiar strony.

page
page True integer

Pobiera lub ustawia stronę.

orderField
orderField string

Pobiera lub ustawia pole kolejności.

orderDirection
orderDirection string

OrderDirection

Zwraca

Ta klasa reprezentuje parametry żądania interfejsu API ReadIncentiveList.

Przypominanie członkom

Ta akcja umożliwia przypomnienie członkowi.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikatorDystrybutora
distributorId True integer

Identyfikator ankiety

messageTemplateId
messageTemplateId True integer

Pobiera lub ustawia identyfikator szablonu wiadomości.

nazwa
name string

Pobiera lub ustawia nazwę.

typ
type string

Pobiera lub ustawia typ.

languageCode
languageCode True string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

scheduleDateTime
scheduleDateTime date-time

Pobiera lub ustawia godzinę harmonogramu.

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

kanał
channel string

Kanał dystrybucji

z
from string

Pobiera lub ustawia z.

fromName
fromName string

Pobiera lub ustawia z nazwy.

OdpowiedzDo
replyTo string

Pobiera lub ustawia odpowiedź.

replyToName
replyToName string

Pobiera lub ustawia nazwę odpowiedzi.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API RemindMembers.

Resetuj wywiad

Ta akcja umożliwia zresetowanie odpowiedzi członka panelu.

Parametry

Nazwa Klucz Wymagane Typ Opis
surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

identyfikator wywiadu
interviewId uuid

Pobiera lub ustawia identyfikator wywiadu.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ResetInterview.

Tworzenie ankiety

Ta akcja umożliwia utworzenie ankiety.

Parametry

Nazwa Klucz Wymagane Typ Opis
workspaceId
workspaceId True integer

Pobiera lub ustawia identyfikator obszaru roboczego.

nazwa
name True string

Pobiera lub ustawia nazwę.

allowMultipleParticipation
allowMultipleParticipation True boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na wielokrotne uczestnictwo].

allowNavigateBack
allowNavigateBack True boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na przechodzenie z powrotem].

allowSaveProgress
allowSaveProgress boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na postęp zapisywania].

randomizeSections
randomizeSections True boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe sekcje].

enableAutoScroll
enableAutoScroll boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz automatyczne przewijanie].

enableCodeAccess
enableCodeAccess boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz dostęp do kodu].

accessType (typ dostępu)
accessType string

Typ dostępu

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

associatedPanels
associatedPanels array of integer

Pobiera lub ustawia identyfikator panelu.

codeAccessMode
codeAccessMode True string

Typ uwierzytelniania

enablePanelSync
enablePanelSync boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz synchronizację panelu].

panelSyncBehaviour
panelSyncBehaviour string

PanelSyncBehaviour

identyfikator
identifier string

Pobiera lub ustawia identyfikator.

panelPole
panelField string

Pobiera lub ustawia pole panelu.

defaultLanguage (język domyślny)
defaultLanguage True string

Pobiera lub ustawia język domyślny.

data zakończenia
endDate date-time

Pobiera lub ustawia datę zakończenia.

Języki
languages True array of string

Pobiera lub ustawia języki.

id
id True integer

Pobiera lub ustawia identyfikator.

nazwa
name True string

Pobiera lub ustawia nazwę.

randomizePages
randomizePages True boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe strony].

excludeFromRandomization
excludeFromRandomization True boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

id
id True integer

Pobiera lub ustawia identyfikator.

elementType
elementType True string

Typ elementu

kod
code string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

languageCode
languageCode True string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

hasHintText
hasHintText boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma tekst wskazówek.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie nie ma dostępnego wyboru.

forceResponse
forceResponse boolean

Pobiera lub ustawia wartość wskazującą, czy [wymuś odpowiedź].

id
id True integer

Pobiera lub ustawia identyfikator.

kod
code True string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

allowTextEntry
allowTextEntry True boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na wpis tekstowy].

forceInput
forceInput True boolean

Pobiera lub ustawia wartość wskazującą, czy [wymuś wejście].

autouzupełnianie
autocomplete True boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.Choice jest autouzupełnianie.

wyłączny
exclusive True boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.Choice jest wyłączny.

excludeFromRandomization
excludeFromRandomization boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

validationType
validationType True string

Walidacja zawartości

najwcześniejsza
earliestDate string

Pobiera lub ustawia najwcześniejszą datę.

latestDate
latestDate string

Pobiera lub ustawia najnowszą datę.

minValue (wartość minimalna)
minValue double

Pobiera lub ustawia minimalną wartość.

maxValue (maksymalna wartość)
maxValue double

Pobiera lub ustawia maksymalną wartość.

liczba miejsc dziesiętnych
decimalPlaces integer

Pobiera lub ustawia miejsca dziesiętne.

disableThousandSeparator
disableThousandSeparator boolean

Pobiera lub ustawia separator tysięcy wyłącz.

conditionAction
conditionAction True string

Filtrowanie

autouzupełnianieListVariable
autocompleteListVariable string

Pobiera lub ustawia zmienną listy autouzupełniania.

randomizeChoices
randomizeChoices boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe wybory].

columnType
columnType string

Typ kolumny

minValue (wartość minimalna)
minValue integer

Pobiera lub ustawia minimalną wartość.

maxValue (maksymalna wartość)
maxValue integer

Pobiera lub ustawia maksymalną wartość.

showCenterLabel
showCenterLabel boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż etykietę środkową].

showValue
showValue boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż wartość].

maxDecimals
maxDecimals integer

Pobiera lub ustawia maksymalną liczbę cyfr po przecinkach.

textFieldSize
textFieldSize string

TextFieldSize

autouzupełnianie
autocomplete boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.SurveyElement jest autouzupełnianie.

hasPlaceholder
hasPlaceholder boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma symbol zastępczy.

isPassword
isPassword boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest hasłem.

minMaxValidation
minMaxValidation boolean

Pobiera lub ustawia wartość wskazującą, czy [minimalna maksymalna weryfikacja].

minimumCheckedChoices
minimumCheckedChoices integer

Pobiera lub ustawia minimalne zaznaczone opcje.

maximumCheckedChoices
maximumCheckedChoices integer

Pobiera lub ustawia maksymalnie zaznaczone opcje.

id
id True integer

Pobiera lub ustawia identyfikator.

hasNotAvailableChoice
hasNotAvailableChoice True boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie nie ma dostępnego wyboru.

randomizeColumns
randomizeColumns True boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe kolumny].

choiceType
choiceType True string

ChoiceType

randomizeRows
randomizeRows boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe wiersze].

id
id True integer

Pobiera lub ustawia identyfikator.

kod
code True string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

excludeFromRandomization
excludeFromRandomization True boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

numberOfRanks
numberOfRanks integer

Pobiera lub ustawia liczbę klasyfikacji.

hasStartText
hasStartText boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma tekst początkowy.

enableMeasurement
enableMeasurement boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz pomiar].

showButtons
showButtons boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż przyciski].

likeKey
likeKey string

Pobiera lub ustawia klucz podobny.

nie lubię klawiszaKey
dislikeKey string

Pobiera lub ustawia nie lubi klucza.

interviewState
interviewState string

Pobiera lub ustawia stan odpowiedzi.

actionType
actionType True string

Limit przydziału

z
from string

Pobiera lub ustawia nadawcę.

na
to string

Pobiera lub ustawia odbiornik.

valueAssignmentType
valueAssignmentType string

ValueAssignmentType

variableName
variableName string

Pobiera lub ustawia nazwę zmiennej.

executionBehavior
executionBehavior string

WykonanieBehavior

apiCallMethod
apiCallMethod string

ApiCallMethod

headers
headers string

Pobiera lub ustawia nagłówki.

externalUri
externalUri string

Pobiera lub ustawia zewnętrzny identyfikator URI.

scriptType
scriptType string

Typ skryptu

zawartość
content string

Pobiera lub ustawia zawartość.

hasRatingLabels
hasRatingLabels boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma etykiety klasyfikacji.

evaluateAsJson
evaluateAsJson boolean

Pobiera lub ustawia wartość wskazującą, czy [oceń jako json].

autouzupełnianieListVariable
autocompleteListVariable string

Pobiera lub ustawia zmienną listy autouzupełniania.

arrangementMode
arrangementMode string

Tryb rozmieszczenia

enableAnimation
enableAnimation boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz animację].

useSmiley
useSmiley boolean

Pobiera lub ustawia wartość wskazującą, czy [użyj buźki].

hasPrompt
hasPrompt boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma monit.

id
id True integer

Pobiera lub ustawia identyfikator.

variableName
variableName True string

Pobiera lub ustawia nazwę zmiennej.

defaultTextOverrides
defaultTextOverrides object

Pobiera lub ustawia domyślne przesłonięcia tekstu.

surveyDesignLayout
surveyDesignLayout integer

Pobiera lub ustawia układ projektu ankiety.

matrixSubQuestionSize
matrixSubQuestionSize string

MatrixSubQuestionSize

nazwa
name string

Pobiera lub ustawia nazwę.

typ
type string

Pobiera lub ustawia typ.

languageCode
languageCode True string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

anonimizowanieMode
anonymizingMode True string

Tryb anonimowości

logIp
logIp True boolean

Pobiera lub ustawia wartość wskazującą, czy [log ip].

logUserAgent
logUserAgent True boolean

Pobiera lub ustawia wartość wskazującą, czy [log user agent].

logReferer
logReferer True boolean

Pobiera lub ustawia wartość wskazującą, czy [referer dziennika].

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateSurvey.

Tworzenie artefaktu

Ta akcja umożliwia utworzenie nowego artefaktu.

Parametry

Nazwa Klucz Wymagane Typ Opis
workspaceId
workspaceId integer

Pobiera lub ustawia identyfikator obszaru roboczego.

ścieżka
path string

Pobiera lub ustawia ścieżkę.

Zwraca

Ta klasa reprezentuje odpowiedź interfejsu API CreateArtifact.

Tworzenie członków

Ta akcja umożliwia utworzenie listy elementów członkowskich.

Parametry

Nazwa Klucz Wymagane Typ Opis
dzierżawa
tenant string

Pobiera lub ustawia dzierżawę.

panelId
panelId True integer

Pobiera lub ustawia identyfikator panelu.

id
id integer

Pobiera lub ustawia identyfikator.

pola
fields True object

Pobiera lub ustawia pola.

createdAt
createdAt date-time

Pobiera lub ustawia utworzony element.

utworzone przez
createdBy string

Pobiera lub ustawia utworzone przez.

updatedAt
updatedAt date-time

Pobiera lub ustawia zaktualizowaną wartość.

zaktualizowanoPrzez
updatedBy string

Pobiera lub ustawia zaktualizowane przez.

id
id string

Identyfikator wywiadu

stan
state string

Pobiera lub ustawia stan.

surveyId
surveyId integer

Identyfikator ankiety

surveyVersionId
surveyVersionId integer

Identyfikator wersji ankiety

surveyName
surveyName string

Nazwa ankiety

surveyState
surveyState string

Pobiera lub ustawia stan ankiety.

answersLink
answersLink string

Link do strony wydruku odpowiedzi

interviewLink
interviewLink string

Pobiera lub ustawia link wywiadu.

startDate
startDate string

Pobiera lub ustawia datę rozpoczęcia.

data zakończenia
endDate string

Pobiera lub ustawia datę zakończenia.

samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateMembers.

Tworzenie elementu webhook

Ta akcja umożliwia utworzenie elementu webhook.

Parametry

Nazwa Klucz Wymagane Typ Opis
eventType
eventType string

Typ Wydarzenia

entityIdentifier
entityIdentifier string

Pobiera lub ustawia identyfikator jednostki.

securityToken
securityToken string

Pobiera lub ustawia token zabezpieczający.

webHookUrl (adres URL elementu webHook)
webHookUrl string

Pobiera lub ustawia adres URL elementu webhook.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateWebHook.

Tworzenie panelu lub przykładu

Ta akcja umożliwia utworzenie nowego panelu.

Parametry

Nazwa Klucz Wymagane Typ Opis
workspaceId
workspaceId True integer

Pobiera lub ustawia identyfikator obszaru roboczego.

nazwa
name True string

Pobiera lub ustawia nazwę panelu.

panelType
panelType True string

PanelModelType

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreatePanel.

Usuwanie elementu webhook

Ta akcja umożliwia usunięcie elementu webhook.

Parametry

Nazwa Klucz Wymagane Typ Opis
webHookId
webHookId uuid

Pobiera lub ustawia identyfikator elementu webhook.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteWebHook.

Usuwanie projektu próbkowania

Ta akcja umożliwia usunięcie projektu próbkowania.

Parametry

Nazwa Klucz Wymagane Typ Opis
samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

keepInterviews
keepInterviews boolean

Pobiera lub ustawia wartość wskazującą, czy [zachowaj wywiady].

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteSamplingProject.

Usuń ankietę

Ta akcja umożliwia usunięcie ankiety.

Parametry

Nazwa Klucz Wymagane Typ Opis
surveyId
surveyId True integer

Pobiera lub ustawia identyfikator ankiety.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteSurvey.

Usuń artefakt

Ta akcja umożliwia usunięcie artefaktu.

Parametry

Nazwa Klucz Wymagane Typ Opis
ścieżka
path string

Pobiera lub ustawia ścieżkę.

filename
filename string

Pobiera lub ustawia nazwę pliku.

workspaceId
workspaceId integer

Pobiera lub ustawia identyfikator obszaru roboczego.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteArtifact.

Usuń członków

Ta akcja umożliwia usunięcie członków.

Parametry

Nazwa Klucz Wymagane Typ Opis
panelId
panelId True integer

Pobiera lub ustawia identyfikator panelu.

panelMembersIds
panelMembersIds True array of integer

Pobiera lub ustawia identyfikator elementu członkowskiego panelu.

keepInterviews
keepInterviews boolean

Pobiera lub ustawia wartość wskazującą, czy [zachowaj wywiady].

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteMember.

Usuń dystrybutora

Ta akcja umożliwia usunięcie dystrybutora.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikatorDystrybutora
distributorId True integer

Pobiera lub ustawia identyfikator dystrybutora.

keepInterviews
keepInterviews boolean

Pobiera lub ustawia wartość wskazującą, czy [zachowaj wywiady].

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteDistributor.

Usuń panel

Ta akcja umożliwia usunięcie panelu.

Parametry

Nazwa Klucz Wymagane Typ Opis
panelId
panelId True integer

Pobiera lub ustawia przykładowy identyfikator.

keepInterviews
keepInterviews boolean

Pobiera lub ustawia wartość wskazującą, czy [zachowaj wywiady].

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteSample.

Usuń wywiad

Ta akcja umożliwia usunięcie wywiadu.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator wywiadu
interviewId uuid

Pobiera lub ustawia identyfikator wywiadu.

surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteInterview.

Wykonywanie przejścia przepływu pracy

Ta akcja umożliwia wykonanie przejścia przepływu pracy specyficznego dla przepływu pracy.

Parametry

Nazwa Klucz Wymagane Typ Opis
przepływ pracy
workflow True string

Typ przepływu pracy

surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

reminderId
reminderId integer

Pobiera lub ustawia identyfikator przypomnienia.

targetState
targetState True string

Pobiera lub ustawia stan obiektu docelowego.

dynamicParameters
dynamicParameters object

Pobiera lub ustawia parametry dynamiczne.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ExecuteWorkflowTransition.

Wyślij wiadomość e-mail

Ta akcja umożliwia wysyłanie wiadomości e-mail.

Parametry

Nazwa Klucz Wymagane Typ Opis
messageTemplateId
messageTemplateId integer

Pobiera lub ustawia identyfikator szablonu wiadomości.

nazwa
name string

Pobiera lub ustawia nazwę.

typ
type string

Pobiera lub ustawia typ.

languageCode
languageCode True string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

język
language True string

Pobiera lub ustawia język.

Temat
subject string

Pobiera lub ustawia temat.

body
body string

Pobiera lub ustawia treść.

z
from True string

Pobiera lub ustawia z.

fromName
fromName string

Pobiera lub ustawia z nazwy.

na
to True string

Pobiera lub ustawia wartość .

toName
toName string

Konwertuje na nazwę.

OdpowiedzDo
replyTo string

Pobiera lub ustawia odpowiedź.

replyToName
replyToName string

Pobiera lub ustawia nazwę odpowiedzi.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API ExecuteSendMail.

Zaproś członków

Ta akcja umożliwia zaproszenie członka.

Parametry

Nazwa Klucz Wymagane Typ Opis
surveyId
surveyId True integer

Identyfikator ankiety

panelId
panelId True integer

Pobiera lub ustawia identyfikator panelu.

samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

memberIds
memberIds array of integer

Pobiera lub ustawia identyfikatory członków panelu.

messageTemplateId
messageTemplateId True integer

Pobiera lub ustawia identyfikator szablonu wiadomości.

nazwa
name string

Pobiera lub ustawia nazwę.

typ
type string

Pobiera lub ustawia typ.

languageCode
languageCode True string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

scheduleDateTime
scheduleDateTime date-time

Pobiera lub ustawia godzinę harmonogramu.

koniunkcja
conjunction True string

Koniunkcja

conditionType
conditionType True string

Typ warunku

identyfikator
identifier True string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Pobiera lub ustawia wartość.

variableType
variableType string

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

kanał
channel string

Kanał dystrybucji

asyncProcess
asyncProcess boolean

Pobiera lub ustawia proces asynchroniczny.

interviewExpiryDate
interviewExpiryDate string

Pobiera lub ustawia datę wygaśnięcia wywiadu.

z
from string

Pobiera lub ustawia z.

fromName
fromName string

Pobiera lub ustawia z nazwy.

OdpowiedzDo
replyTo string

Pobiera lub ustawia odpowiedź.

replyToName
replyToName string

Pobiera lub ustawia nazwę odpowiedzi.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API InviteMembers.

Zaproś członków

Ta akcja umożliwia tworzenie i zapraszanie członków.

Parametry

Nazwa Klucz Wymagane Typ Opis
samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

surveyId
surveyId True integer

Pobiera lub ustawia identyfikator ankiety.

panelId
panelId True integer

Pobiera lub ustawia identyfikator panelu.

kanał
channel True string

Kanał dystrybucji

messageTemplateId
messageTemplateId True integer

Pobiera lub ustawia identyfikator szablonu wiadomości.

nazwa
name string

Pobiera lub ustawia nazwę.

typ
type string

Pobiera lub ustawia typ.

languageCode
languageCode True string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

id
id integer

Pobiera lub ustawia identyfikator.

pola
fields True object

Pobiera lub ustawia pola.

createdAt
createdAt date-time

Pobiera lub ustawia utworzony element.

utworzone przez
createdBy string

Pobiera lub ustawia utworzone przez.

updatedAt
updatedAt date-time

Pobiera lub ustawia zaktualizowaną wartość.

zaktualizowanoPrzez
updatedBy string

Pobiera lub ustawia zaktualizowane przez.

id
id string

Identyfikator wywiadu

stan
state string

Pobiera lub ustawia stan.

surveyId
surveyId integer

Identyfikator ankiety

surveyVersionId
surveyVersionId integer

Identyfikator wersji ankiety

surveyName
surveyName string

Nazwa ankiety

surveyState
surveyState string

Pobiera lub ustawia stan ankiety.

answersLink
answersLink string

Link do strony wydruku odpowiedzi

interviewLink
interviewLink string

Pobiera lub ustawia link wywiadu.

startDate
startDate string

Pobiera lub ustawia datę rozpoczęcia.

data zakończenia
endDate string

Pobiera lub ustawia datę zakończenia.

samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

scheduleDateTime
scheduleDateTime string

Pobiera lub ustawia harmonogram daty i godziny.

asyncProcess
asyncProcess boolean

Pobiera lub ustawia proces asynchroniczny.

interviewExpiryDate
interviewExpiryDate string

Pobiera lub ustawia datę wygaśnięcia wywiadu.

z
from string

Pobiera lub ustawia z.

fromName
fromName string

Pobiera lub ustawia z nazwy.

OdpowiedzDo
replyTo string

Pobiera lub ustawia odpowiedź.

replyToName
replyToName string

Pobiera lub ustawia nazwę odpowiedzi.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateAndInviteMembers.

Zrealizuj kod zachęty

Ta akcja umożliwia wydawanie środków ankietowych na zachęty/bony.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator zachęty
incentiveId True integer

Pobiera lub ustawia identyfikator zachęty.

Zwraca

Ta klasa reprezentuje parametry zwracane dla interfejsu API RedeemIncentiveCode.

Definicje

Typ dostępu

Typ dostępu

Typ dostępu

Element akcji

Ta klasa reprezentuje koniec akcji ankiety dla pełnej/zrzutu ekranu/limitu przydziału.

Nazwa Ścieżka Typ Opis
actionType
actionType ActionType

Limit przydziału

endOfSurveyText
endOfSurveyText array of TranslationElement

Pobiera lub ustawia koniec tekstu ankiety.

forwardUrl
forwardUrl array of TranslationElement

Pobiera lub ustawia adres URL przekazywania dalej.

Typ akcji

Limit przydziału

Limit przydziału

AnonimizacjaKonfiguracja

Ta klasa zawiera ustawienia anonimizacji, które można zastosować do grupy obszarów roboczych, obszaru roboczego lub pojedynczej ankiety.

Nazwa Ścieżka Typ Opis
anonimizowanieMode
anonymizingMode AnonymizingMode

Tryb anonimowości

logIp
logIp boolean

Pobiera lub ustawia wartość wskazującą, czy [log ip].

logUserAgent
logUserAgent boolean

Pobiera lub ustawia wartość wskazującą, czy [log user agent].

logReferer
logReferer boolean

Pobiera lub ustawia wartość wskazującą, czy [referer dziennika].

Tryb anonimowości

Tryb anonimowości

Tryb anonimowości

ApiCallMethod

ApiCallMethod

ApiCallMethod

Tryb rozmieszczenia

Tryb rozmieszczenia

Tryb rozmieszczenia

BounceElement

Ta klasa reprezentuje koniec akcji ankiety dla pełnej/zrzutu ekranu/limitu przydziału.

Nazwa Ścieżka Typ Opis
identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

identyfikator wywiadu
interviewId uuid

Pobiera lub ustawia identyfikator wywiadu.

panelId
panelId integer

Pobiera lub ustawia identyfikator panelu.

panelMemberId
panelMemberId integer

Pobiera lub ustawia identyfikator elementu członkowskiego panelu.

bounceType
bounceType BounceType

BounceType

sygnatura czasowa
timestamp date-time

Pobiera lub ustawia znacznik czasu.

stan
state string

Pobiera lub ustawia stan.

powód
reason string

Pobiera lub ustawia przyczynę.

e-mail
email string

Pobiera lub ustawia wiadomość e-mail.

phone
phone integer

Pobiera lub ustawia telefon.

invitationType
invitationType InvitationType

Typ zaproszenia

BounceType

BounceType

BounceType

Wybór

Ta klasa reprezentuje pojedynczy wybór, który może być używany w każdym typie pytania wyboru.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

kod
code string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

SMS
text array of TranslationElement

Pobiera lub ustawia tłumaczenia tekstu.

allowTextEntry
allowTextEntry boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na wpis tekstowy].

forceInput
forceInput boolean

Pobiera lub ustawia wartość wskazującą, czy [wymuś wejście].

autouzupełnianie
autocomplete boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.Choice jest autouzupełnianie.

autouzupełnianieTekst
autocompleteText array of TranslationElement

Pobiera lub ustawia autouzupełnianie tłumaczeń tekstu.

wyłączny
exclusive boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.Choice jest wyłączny.

excludeFromRandomization
excludeFromRandomization boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

contentValidation
contentValidation ContentValidation

Ta klasa reprezentuje walidację zawartości wewnątrz ankiety.

condition
condition ConditionDefinition

Ta klasa reprezentuje definicję elementów warunków.

autouzupełnianieListVariable
autocompleteListVariable string

Pobiera lub ustawia zmienną listy autouzupełniania.

ChoiceType

ChoiceType

ChoiceType

CodeAccessMode

Typ uwierzytelniania

Typ uwierzytelniania

ColItem

Ta klasa reprezentuje komórkę odpowiedzi ankiety.

Nazwa Ścieżka Typ Opis
id
id string

Pobiera lub ustawia identyfikator.

value
value

Pobiera lub ustawia wartość.

Grupa kolumn

Ta klasa reprezentuje grupę kolumn wewnątrz złożonych typów pytań, takich jak pytania macierzowe.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

SMS
text array of TranslationElement

Pobiera lub ustawia tłumaczenia tekstu.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie nie ma dostępnego wyboru.

notAvailableChoiceText
notAvailableChoiceText array of TranslationElement

Pobiera lub ustawia niedostępne tłumaczenia tekstu.

randomizeColumns
randomizeColumns boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe kolumny].

monit
prompt array of TranslationElement

Pobiera lub ustawia monit.

choiceType
choiceType ChoiceType

ChoiceType

choices
choices array of Choice

Pobiera lub ustawia opcje.

condition
condition ConditionDefinition

Ta klasa reprezentuje definicję elementów warunków.

Typ kolumny

Typ kolumny

Typ kolumny

Condition

Ta klasa jest bazą dla wszystkich elementów warunku.

Nazwa Ścieżka Typ Opis
koniunkcja
conjunction Conjunction

Koniunkcja

conditionType
conditionType ConditionType

Typ warunku

identyfikator
identifier string

Pobiera lub ustawia identyfikator.

conditionOperator
conditionOperator ConditionOperator

ConditionOperator

value
value string

Pobiera lub ustawia wartość.

variableType
variableType VariableType

Typ zmiennej

jsonValue
jsonValue boolean

Pobiera lub ustawia wartość wskazującą, czy [wartość json].

jsonPath
jsonPath string

Pobiera lub ustawia ścieżkę json.

WarunekAkcja

Filtrowanie

Filtrowanie

WarunekDefinition

Ta klasa reprezentuje definicję elementów warunków.

Nazwa Ścieżka Typ Opis
conditionAction
conditionAction ConditionAction

Filtrowanie

pierwiastki
elements array of Condition

Pobiera lub ustawia elementy.

ConditionOperator

ConditionOperator

ConditionOperator

Typ warunku

Typ warunku

Typ warunku

Koniunkcja

Koniunkcja

Koniunkcja

Walidacja zawartości

Ta klasa reprezentuje walidację zawartości wewnątrz ankiety.

Nazwa Ścieżka Typ Opis
validationType
validationType ContentValidationType

Walidacja zawartości

najwcześniejsza
earliestDate string

Pobiera lub ustawia najwcześniejszą datę.

latestDate
latestDate string

Pobiera lub ustawia najnowszą datę.

minValue (wartość minimalna)
minValue double

Pobiera lub ustawia minimalną wartość.

maxValue (maksymalna wartość)
maxValue double

Pobiera lub ustawia maksymalną wartość.

liczba miejsc dziesiętnych
decimalPlaces integer

Pobiera lub ustawia miejsca dziesiętne.

disableThousandSeparator
disableThousandSeparator boolean

Pobiera lub ustawia separator tysięcy wyłącz.

ContentValidationType

Walidacja zawartości

Walidacja zawartości

CreateAndInviteMembersResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateAndInviteMembers.

Nazwa Ścieżka Typ Opis
samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

validationIssues
validationIssues array of WritePanelMemberIssue

Pobiera lub ustawia problemy.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

CreateArtifactResponse

Ta klasa reprezentuje odpowiedź interfejsu API CreateArtifact.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

CreateMembersResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateMembers.

Nazwa Ścieżka Typ Opis
identyfikatory elementów członkowskich
membersIds array of integer

Pobiera lub ustawia identyfikatory elementów członkowskich.

validationIssues
validationIssues array of WritePanelMemberIssue

Pobiera lub ustawia problemy.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

CreatePanelResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreatePanel.

Nazwa Ścieżka Typ Opis
id
id integer

Pobierz identyfikator utworzonego panelu.

nazwa
name string

Pobierz nazwę utworzonego panelu.

isExtendedPanel
isExtendedPanel boolean

Pobierz typ utworzonego panelu.

data utworzenia
createdDate string

Pobierz datę utworzenia utworzonego panelu.

isLock
isLock boolean

Pobierz wartość wskazującą, czy panel jest zablokowany.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

CreateSurveyResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateSurvey.

Nazwa Ścieżka Typ Opis
surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

Tworzenie elementuWebHookResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateWebHook.

Nazwa Ścieżka Typ Opis
webHookId
webHookId uuid

Pobiera lub ustawia identyfikator elementu webhook.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

Zmienna niestandardowa

Ta klasa reprezentuje pojedynczą zmienną niestandardową.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

variableName
variableName string

Pobiera lub ustawia nazwę zmiennej.

variableType
variableType VariableType

Typ zmiennej

DataAccessControl

Ta klasa zawiera konfigurację sposobu, w jaki jednostka jest dostępna

Nazwa Ścieżka Typ Opis
accessType (typ dostępu)
accessType AccessType

Typ dostępu

Warunki
conditions array of Condition

Pobiera lub ustawia warunki.

DeleteArtifactResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteArtifact.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

DeleteDistributorResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteDistributor.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

DeleteInterviewResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteInterview.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

DeleteMembersResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteMember.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

DeletePanelResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteSample.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

DeleteSamplingProjectResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteSamplingProject.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

DeleteSurveyResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteSurvey.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

Usuń elementWebHookResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DeleteWebHook.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

Konfiguracja projektu

Ta klasa reprezentuje możliwości stylów dla konta.

Nazwa Ścieżka Typ Opis
surveyDesignLayout
surveyDesignLayout integer

Pobiera lub ustawia układ projektu ankiety.

matrixSubQuestionSize
matrixSubQuestionSize MatrixSubQuestionSize

MatrixSubQuestionSize

textBlocks
textBlocks array of TextBlock

Pobiera lub ustawia zawartość szablonu.

DistributionChannel

Kanał dystrybucji

Kanał dystrybucji

DystrybutorElement

Ta klasa reprezentuje element dystrybutora.

Nazwa Ścieżka Typ Opis
identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

distributionChannel
distributionChannel DistributionChannel

Kanał dystrybucji

surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

surveyVersion
surveyVersion integer

Pobiera lub ustawia wersję ankiety.

panelId
panelId integer

Pobiera lub ustawia identyfikator panelu.

scheduledDistribution
scheduledDistribution date-time

Pobiera lub ustawia zaplanowaną dystrybucję.

executedDistribution
executedDistribution date-time

Pobiera lub ustawia wykonaną dystrybucję.

distributionState
distributionState string

Pobiera lub ustawia stan rozkładu.

Warunki
conditions array of ConditionDefinition

Pobiera lub ustawia warunki.

DownloadAnswersResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API DownloadAnswers.

Nazwa Ścieżka Typ Opis
Adres URL pobierania
downloadUrl string

Pobiera lub ustawia adres URL pobierania.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

Typ elementu

Typ elementu

Typ elementu

Typ Wydarzenia

Typ Wydarzenia

Typ Wydarzenia

ExecuteSendMailResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ExecuteSendMail.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ExecuteWorkflowTransitionResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ExecuteWorkflowTransition.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

WykonanieBehavior

WykonanieBehavior

WykonanieBehavior

Wywiad

Ta klasa reprezentuje dane rekordu wywiadu

Nazwa Ścieżka Typ Opis
id
id string

Identyfikator wywiadu

stan
state string

Pobiera lub ustawia stan.

surveyId
surveyId integer

Identyfikator ankiety

surveyVersionId
surveyVersionId integer

Identyfikator wersji ankiety

surveyName
surveyName string

Nazwa ankiety

surveyState
surveyState string

Pobiera lub ustawia stan ankiety.

answersLink
answersLink string

Link do strony wydruku odpowiedzi

interviewLink
interviewLink string

Pobiera lub ustawia link wywiadu.

startDate
startDate string

Pobiera lub ustawia datę rozpoczęcia.

data zakończenia
endDate string

Pobiera lub ustawia datę zakończenia.

samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

Typ zaproszenia

Typ zaproszenia

Typ zaproszenia

InviteMembersResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API InviteMembers.

Nazwa Ścieżka Typ Opis
samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

identyfikatorDystrybutora
distributorId integer

Pobiera lub ustawia identyfikator dystrybutora.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

MatrixSubQuestionSize

MatrixSubQuestionSize

MatrixSubQuestionSize

Członek

Ta klasa reprezentuje pojedynczy element członkowski panelu z dynamiczną strukturą opartą na panelu.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

pola
fields object

Pobiera lub ustawia pola.

createdAt
createdAt date-time

Pobiera lub ustawia utworzony element.

utworzone przez
createdBy string

Pobiera lub ustawia utworzone przez.

updatedAt
updatedAt date-time

Pobiera lub ustawia zaktualizowaną wartość.

zaktualizowanoPrzez
updatedBy string

Pobiera lub ustawia zaktualizowane przez.

Wywiady
interviews array of Interview

Pobiera lub ustawia wywiady.

MessageTemplateItem

Ta klasa reprezentuje jeden element szablonu wiadomości.

Nazwa Ścieżka Typ Opis
id
id integer

Identyfikator wiadomości e-mail

nazwa
name string

Nazwa wiadomości e-mail

zawartość
content string

Zawartość wiadomości e-mail

Temat
subject string

Temat wiadomości e-mail

defaultLocale (ustawienia regionalne)
defaultLocale string

Domyślne ustawienia regionalne wiadomości e-mail

Ustawień regionalnych
locales array of string

Lista ustawień regionalnych dla tej wiadomości e-mail

MinMaxChoice

Ta klasa reprezentuje minimalny element wyboru maksymalnego w ankiecie.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

kod
code string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

leftText
leftText array of TranslationElement

Pobiera lub ustawia tłumaczenia tekstu po lewej stronie.

rightText
rightText array of TranslationElement

Pobiera lub ustawia odpowiednie tłumaczenia tekstu.

excludeFromRandomization
excludeFromRandomization boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

condition
condition ConditionDefinition

Ta klasa reprezentuje definicję elementów warunków.

OptOutItem

Ta klasa reprezentuje jeden element Opt-Out.

Nazwa Ścieżka Typ Opis
e-mail
email string

Pobiera lub ustawia wiadomość e-mail.

phone
phone integer

Pobiera lub ustawia telefon.

optOutAt
optOutAt string

Pobiera lub ustawia rezygnację na.

optOutBy
optOutBy string

Pobiera lub ustawia rezygnację.

PanelDefinition

Ta klasa zawiera pełną definicję wszystkich pól zawartych w panelu zdefiniowanym przez klienta.

Nazwa Ścieżka Typ Opis
groups
groups array of VariableGroupElement

Pobiera lub ustawia grupy.

dataAccessControl
dataAccessControl DataAccessControl

Ta klasa zawiera konfigurację sposobu, w jaki jednostka jest dostępna

PanelFieldItem

Ta klasa reprezentuje pole panelu wewnątrz panelu.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

nazwa
name string

Pobiera lub ustawia nazwę.

nazwa wyświetlana
displayName string

Pobiera lub ustawia nazwę wyświetlaną.

isSystem
isSystem boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest systemem.

obowiązkowy
mandatory boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.PanelFieldItem jest obowiązkowy.

anonimizowanie
anonymize boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.PanelFieldItem jest anonimizacją.

validationExpression
validationExpression string

Pobiera lub ustawia wyrażenie weryfikacji.

validationErrorMessageId
validationErrorMessageId string

Pobiera lub ustawia identyfikator komunikatu weryfikacji.

panelFieldType
panelFieldType VariableType

Typ zmiennej

metadane
metadata object

Pobiera lub ustawia metadane.

PanelIncentive

Ta klasa reprezentuje jedną zachętę.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

nazwa
name string

Pobiera lub ustawia nazwę.

priceInCredits
priceInCredits integer

Pobiera lub ustawia cenę w środkach.

opis
description string

Pobiera lub ustawia opis.

availableVouchersCount
availableVouchersCount integer

Pobiera lub ustawia liczbę dostępnych bonów.

PanelSyncBehaviour

PanelSyncBehaviour

PanelSyncBehaviour

PanelSyncElement

Ta klasa reprezentuje pojedynczy element synchronizacji między ankietą a panelem.

Nazwa Ścieżka Typ Opis
identyfikator
identifier string

Pobiera lub ustawia identyfikator.

panelPole
panelField string

Pobiera lub ustawia pole panelu.

ReadArtifactListRequest

Ta klasa reprezentuje parametry żądania interfejsu API ReadArtifactList.

Nazwa Ścieżka Typ Opis
ścieżka
path string

Pobiera lub ustawia ścieżkę.

workspaceId
workspaceId integer

Pobiera lub ustawia identyfikator obszaru roboczego.

ReadBounceListResponseV3

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadBounceList.

Nazwa Ścieżka Typ Opis
Odbija
bounces array of BounceElement

Pobiera lub ustawia listę odbić.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadCreditBalanceResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadCreditBalance.

Nazwa Ścieżka Typ Opis
saldo
balance integer

Pobiera lub ustawia saldo.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadDistributorListResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadDistributorList.

Nazwa Ścieżka Typ Opis
Dystrybutorów
distributors array of DistributorElement

Pobiera lub ustawia dystrybutorów.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadIncentiveListResponse

Ta klasa reprezentuje parametry żądania interfejsu API ReadIncentiveList.

Nazwa Ścieżka Typ Opis
panel Zachęty
panelIncentives array of PanelIncentive

Pobiera lub ustawia zachęty panelu.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadIncentiveTransactionListResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadIncentiveTransactionList.

Nazwa Ścieżka Typ Opis
transakcje zachęt
incentiveTransactions array of SurveyCreditLog

Pobiera lub ustawia transakcje zachęt.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadInterviewDataResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadInterviewData.

Nazwa Ścieżka Typ Opis
dane odpowiedzi
responseData object

Pobiera lub ustawia dane odpowiedzi.

surveyDefinition
surveyDefinition SurveyDefinition

Ta klasa reprezentuje definicję ankiety zawierającej wszystkie metadane i ustawienia.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadInterviewListCompactResponseV3

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadInterviewListCompact.

Nazwa Ścieżka Typ Opis
surveyName
surveyName string

Pobiera lub ustawia nazwę ankiety.

surveyDefaultLanguage
surveyDefaultLanguage string

Pobiera lub ustawia domyślny język ankiety.

surveyLanguages
surveyLanguages array of string

Pobiera lub ustawia języki ankiety.

Wywiady
interviews array of object

Pobiera lub ustawia wywiady.

items
interviews object
codePlan
codePlan array of SurveyMetadataItem

Pobiera lub ustawia plan kodu.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadInterviewListResponseV3

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadInterviewList.

Nazwa Ścieżka Typ Opis
surveyName
surveyName string

Pobiera lub ustawia nazwę ankiety.

surveyDefaultLanguage
surveyDefaultLanguage string

Pobiera lub ustawia domyślny język ankiety.

surveyLanguages
surveyLanguages array of string

Pobiera lub ustawia języki ankiety.

codePlan
codePlan array of SurveyMetadataItem

Pobiera lub ustawia plan kodu.

Wywiady
interviews array of Row

Pobiera lub ustawia wywiady.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadMemberListResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadMemberList.

Nazwa Ścieżka Typ Opis
Członkowie
members array of Member

Pobiera lub ustawia członków panelu.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadMessageTemplateListResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadMessageTemplateList.

Nazwa Ścieżka Typ Opis
messageTemplates
messageTemplates array of MessageTemplateItem

Pobiera lub ustawia szablony komunikatów.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadOptOutListResponseV3

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadOptOutList.

Nazwa Ścieżka Typ Opis
optOutItems
optOutItems array of OptOutItem

Pobiera lub ustawia elementy rezygnacji.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadPanelDefinitionResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadPanelDefinition.

Nazwa Ścieżka Typ Opis
panel
panel PanelDefinition

Ta klasa zawiera pełną definicję wszystkich pól zawartych w panelu zdefiniowanym przez klienta.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadSamplingProjectResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadSamplingProject.

Nazwa Ścieżka Typ Opis
samplingProject
samplingProject SamplingProjectElement

Ta klasa reprezentuje projekt próbkowania.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadSurveyLinksResponse

Ta klasa reprezentuje odpowiedź interfejsu API ReadSurveyLinks.

Nazwa Ścieżka Typ Opis
anonymousList
anonymousList array of SurveyLink

Pobiera lub ustawia listę anonimową.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadSurveyListResponse

Ta klasa reprezentuje parametry odpowiedzi interfejsu API ReadSurveyList.

Nazwa Ścieżka Typ Opis
Badania
surveys array of SurveyListItem

Pobiera lub ustawia ankiety.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadSurveyResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadSurveyDefinition.

Nazwa Ścieżka Typ Opis
surveyName
surveyName string

Pobiera lub ustawia nazwę ankiety.

surveyVersion
surveyVersion integer

Pobiera lub ustawia wersję ankiety.

surveyState
surveyState string

Pobiera lub ustawia stan ankiety.

createdAt
createdAt string

Pobiera lub ustawia utworzony element.

utworzone przez
createdBy string

Pobiera lub ustawia utworzone przez.

ankieta
survey SurveyDefinition

Ta klasa reprezentuje definicję ankiety zawierającej wszystkie metadane i ustawienia.

surveyConfiguration
surveyConfiguration SurveyConfiguration

Ta klasa reprezentuje konfigurację ankiety ze wszystkimi ustawieniami, które użytkownik może skonfigurować.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadWebHookListResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadWebHookList.

Nazwa Ścieżka Typ Opis
Elementy webHook
webHooks array of WebHookElement

Pobiera lub ustawia elementy webhook.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadWorkflowTransitionsResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ReadWorkflowTransitions.

Nazwa Ścieżka Typ Opis
Przejścia
transitions array of WorkflowTransition

Pobiera lub ustawia przejścia.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ReadWorkspaceListResponse

Ta klasa reprezentuje parametry żądania dla interfejsu API ReadWorkspaceList.

Nazwa Ścieżka Typ Opis
workspaces
workspaces array of WorkspaceDto

Pobiera lub ustawia obszary robocze.

totalCount
totalCount integer

Pobiera lub ustawia łączną liczbę.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

RedeemIncentiveCodeResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API RedeemIncentiveCode.

Nazwa Ścieżka Typ Opis
voucherCode
voucherCode string

Pobiera lub ustawia kod kuponu.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

RemindMembersResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API RemindMembers.

Nazwa Ścieżka Typ Opis
reminderId
reminderId integer

Pobiera lub ustawia identyfikator przypomnienia.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ResetInterviewResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API ResetInterview.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

Row

Ta klasa reprezentuje jeden element wiersza.

Nazwa Ścieżka Typ Opis
columns
columns array of ColItem

Pobiera lub ustawia kolumny.

RowItem

Ta klasa reprezentuje odpowiedź na ankietę.

Nazwa Ścieżka Typ Opis
id
id string

Pobiera lub ustawia identyfikator.

value
value string

Pobiera lub ustawia wartość.

SamplingProjectElement

Ta klasa reprezentuje projekt próbkowania.

Nazwa Ścieżka Typ Opis
samplingProjectId
samplingProjectId integer

Pobiera lub ustawia identyfikator projektu próbkowania.

nazwa
name string

Pobiera lub ustawia nazwę.

workspaceId
workspaceId integer

Pobiera lub ustawia identyfikator obszaru roboczego.

surveyId
surveyId integer

Pobiera lub ustawia identyfikator ankiety.

surveyVersion
surveyVersion integer

Pobiera lub ustawia wersję ankiety.

panelId
panelId integer

Pobiera lub ustawia identyfikator panelu.

samplingProviderId
samplingProviderId integer

Pobiera lub ustawia identyfikator dostawcy próbkowania.

projectState
projectState string

Pobiera lub ustawia stan projektu.

scheduledDistribution
scheduledDistribution string

Pobiera lub ustawia zaplanowaną dystrybucję.

executedDistribution
executedDistribution string

Pobiera lub ustawia wykonaną dystrybucję.

Warunki
conditions array of ConditionDefinition

Pobiera lub ustawia warunki.

Typ skryptu

Typ skryptu

Typ skryptu

Section

Ta klasa reprezentuje sekcję wewnątrz ankiety.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

nazwa
name string

Pobiera lub ustawia nazwę.

randomizePages
randomizePages boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe strony].

excludeFromRandomization
excludeFromRandomization boolean

Pobiera lub ustawia wartość wskazującą, czy [wyklucz z losowania].

pierwiastki
elements array of SurveyElement

Pobiera lub ustawia elementy.

condition
condition ConditionDefinition

Ta klasa reprezentuje definicję elementów warunków.

SurveyConfiguration

Ta klasa reprezentuje konfigurację ankiety ze wszystkimi ustawieniami, które użytkownik może skonfigurować.

Nazwa Ścieżka Typ Opis
designConfiguration
designConfiguration DesignConfiguration

Ta klasa reprezentuje możliwości stylów dla konta.

anonimizacjaKonfiguracja
anonymizingConfiguration AnonymizingConfiguration

Ta klasa zawiera ustawienia anonimizacji, które można zastosować do grupy obszarów roboczych, obszaru roboczego lub pojedynczej ankiety.

SurveyCreditLog

Ta klasa reprezentuje jedną transakcję kredytową.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

oldValue
oldValue string

Pobiera lub ustawia starą wartość.

newValue
newValue string

Pobiera lub ustawia nową wartość.

opis
description string

Pobiera lub ustawia opis.

modifiedDate
modifiedDate string

Pobiera lub ustawia datę modyfikacji.

modifiedBy
modifiedBy string

Pobiera lub ustawia zmodyfikowane przez.

responseId
responseId uuid

Pobiera lub ustawia identyfikator odpowiedzi.

interviewLink
interviewLink string

Pobiera lub ustawia link wywiadu.

AnkietaDefinition

Ta klasa reprezentuje definicję ankiety zawierającej wszystkie metadane i ustawienia.

Nazwa Ścieżka Typ Opis
allowMultipleParticipation
allowMultipleParticipation boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na wielokrotne uczestnictwo].

allowNavigateBack
allowNavigateBack boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na przechodzenie z powrotem].

allowSaveProgress
allowSaveProgress boolean

Pobiera lub ustawia wartość wskazującą, czy [zezwalaj na postęp zapisywania].

randomizeSections
randomizeSections boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe sekcje].

enableAutoScroll
enableAutoScroll boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz automatyczne przewijanie].

enableCodeAccess
enableCodeAccess boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz dostęp do kodu].

dataAccessControl
dataAccessControl DataAccessControl

Ta klasa zawiera konfigurację sposobu, w jaki jednostka jest dostępna

associatedPanels
associatedPanels array of integer

Pobiera lub ustawia identyfikator panelu.

codeAccessMode
codeAccessMode CodeAccessMode

Typ uwierzytelniania

enablePanelSync
enablePanelSync boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz synchronizację panelu].

panelSyncBehaviour
panelSyncBehaviour PanelSyncBehaviour

PanelSyncBehaviour

panelSyncs
panelSyncs array of PanelSyncElement

Pobiera lub ustawia synchronizacje panelu.

defaultLanguage (język domyślny)
defaultLanguage string

Pobiera lub ustawia język domyślny.

data zakończenia
endDate date-time

Pobiera lub ustawia datę zakończenia.

Języki
languages array of string

Pobiera lub ustawia języki.

Sekcje
sections array of Section

Pobiera lub ustawia sekcje.

customVariables
customVariables array of CustomVariable

Pobiera lub ustawia zmienne niestandardowe.

surveyEndText
surveyEndText array of TranslationElement

Pobiera lub ustawia tekst końcowy ankiety.

defaultTextOverrides
defaultTextOverrides object

Pobiera lub ustawia domyślne przesłonięcia tekstu.

SurveyElement

Ta klasa reprezentuje definicję elementu ankiety ze wszystkimi metadanymi i ustawieniami.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

elementType
elementType ElementType

Typ elementu

kod
code string

Pobiera lub ustawia kod.

codeManuallyChanged
codeManuallyChanged boolean

Pobiera lub ustawia wartość wskazującą, czy [kod został ręcznie zmieniony].

SMS
text array of TranslationElement

Pobiera lub ustawia tłumaczenia tekstu.

hintText
hintText array of TranslationElement

Pobiera lub ustawia tłumaczenia tekstu wskazówek.

hasHintText
hasHintText boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma tekst wskazówek.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie nie ma dostępnego wyboru.

notAvailableChoiceText
notAvailableChoiceText array of TranslationElement

Pobiera lub ustawia niedostępne tłumaczenia tekstu.

forceResponse
forceResponse boolean

Pobiera lub ustawia wartość wskazującą, czy [wymuś odpowiedź].

choices
choices array of Choice

Pobiera lub ustawia opcje.

randomizeChoices
randomizeChoices boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe wybory].

columnType
columnType ColumnType

Typ kolumny

monit
prompt array of TranslationElement

Pobiera lub ustawia monit.

minValue (wartość minimalna)
minValue integer

Pobiera lub ustawia minimalną wartość.

maxValue (maksymalna wartość)
maxValue integer

Pobiera lub ustawia maksymalną wartość.

showCenterLabel
showCenterLabel boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż etykietę środkową].

leftLabel
leftLabel array of TranslationElement

Pobiera lub ustawia lewą etykietę.

centerLabel
centerLabel array of TranslationElement

Pobiera lub ustawia etykietę środkową.

rightLabel
rightLabel array of TranslationElement

Pobiera lub ustawia odpowiednią etykietę.

showValue
showValue boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż wartość].

maxDecimals
maxDecimals integer

Pobiera lub ustawia maksymalną liczbę cyfr po przecinkach.

textFieldSize
textFieldSize TextFieldSize

TextFieldSize

autouzupełnianie
autocomplete boolean

Pobiera lub ustawia wartość wskazującą, czy ten survalyzer.Contracts.Public.Elements.SurveyElement jest autouzupełnianie.

autouzupełnianieTekst
autocompleteText array of TranslationElement

Pobiera lub ustawia autouzupełnianie tłumaczeń tekstu.

contentValidation
contentValidation ContentValidation

Ta klasa reprezentuje walidację zawartości wewnątrz ankiety.

hasPlaceholder
hasPlaceholder boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma symbol zastępczy.

symbol zastępczy
placeholder array of TranslationElement

Pobiera lub ustawia symbol zastępczy.

isPassword
isPassword boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest hasłem.

minMaxValidation
minMaxValidation boolean

Pobiera lub ustawia wartość wskazującą, czy [minimalna maksymalna weryfikacja].

minimumCheckedChoices
minimumCheckedChoices integer

Pobiera lub ustawia minimalne zaznaczone opcje.

maximumCheckedChoices
maximumCheckedChoices integer

Pobiera lub ustawia maksymalnie zaznaczone opcje.

columnGroups
columnGroups array of ColumnGroup

Pobiera lub ustawia grupy kolumn.

randomizeRows
randomizeRows boolean

Pobiera lub ustawia wartość wskazującą, czy [losowe wiersze].

Wierszy
rows array of MinMaxChoice

Pobiera lub ustawia wiersze.

numberOfRanks
numberOfRanks integer

Pobiera lub ustawia liczbę klasyfikacji.

likeText
likeText array of TranslationElement

Pobiera lub ustawia podobne tłumaczenia tekstu.

nie lubię tekstu
dislikeText array of TranslationElement

Pobiera lub ustawia nie lubi tłumaczenia tekstu.

hasStartText
hasStartText boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma tekst początkowy.

startText
startText array of TranslationElement

Pobiera lub ustawia tekst początkowy.

enableMeasurement
enableMeasurement boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz pomiar].

showButtons
showButtons boolean

Pobiera lub ustawia wartość wskazującą, czy [pokaż przyciski].

likeKey
likeKey string

Pobiera lub ustawia klucz podobny.

nie lubię klawiszaKey
dislikeKey string

Pobiera lub ustawia nie lubi klucza.

interviewState
interviewState string

Pobiera lub ustawia stan odpowiedzi.

akcja
action ActionElement

Ta klasa reprezentuje koniec akcji ankiety dla pełnej/zrzutu ekranu/limitu przydziału.

z
from string

Pobiera lub ustawia nadawcę.

na
to string

Pobiera lub ustawia odbiornik.

Temat
subject array of TranslationElement

Pobiera lub ustawia tłumaczenia tematu.

komunikat
message array of TranslationElement

Pobiera lub ustawia tłumaczenia komunikatów.

valueAssignmentType
valueAssignmentType ValueAssignmentType

ValueAssignmentType

variableName
variableName string

Pobiera lub ustawia nazwę zmiennej.

functionTerm
functionTerm array of TranslationElement

Pobiera lub ustawia termin funkcji.

executionBehavior
executionBehavior ExecutionBehavior

WykonanieBehavior

apiCallMethod
apiCallMethod ApiCallMethod

ApiCallMethod

URL
url array of TranslationElement

Pobiera lub ustawia adres URL.

headers
headers string

Pobiera lub ustawia nagłówki.

body
body array of TranslationElement

Pobiera lub ustawia treść.

externalUri
externalUri string

Pobiera lub ustawia zewnętrzny identyfikator URI.

scriptType
scriptType ScriptType

Typ skryptu

zawartość
content string

Pobiera lub ustawia zawartość.

hasRatingLabels
hasRatingLabels boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma etykiety klasyfikacji.

leftRatingLabel
leftRatingLabel array of TranslationElement

Pobiera lub ustawia lewą etykietę klasyfikacji.

rightRatingLabel
rightRatingLabel array of TranslationElement

Pobiera lub ustawia odpowiednią etykietę klasyfikacji.

condition
condition ConditionDefinition

Ta klasa reprezentuje definicję elementów warunków.

evaluateAsJson
evaluateAsJson boolean

Pobiera lub ustawia wartość wskazującą, czy [oceń jako json].

autouzupełnianieListVariable
autocompleteListVariable string

Pobiera lub ustawia zmienną listy autouzupełniania.

arrangementMode
arrangementMode ArrangementMode

Tryb rozmieszczenia

enableAnimation
enableAnimation boolean

Pobiera lub ustawia wartość wskazującą, czy [włącz animację].

useSmiley
useSmiley boolean

Pobiera lub ustawia wartość wskazującą, czy [użyj buźki].

hasPrompt
hasPrompt boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie ma monit.

Jednostka SurveyLink

Nazwa Ścieżka Typ Opis
URL
url string

Pobiera lub ustawia adres URL.

isCustom
isCustom boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest niestandardowe.

język
language string

Pobiera lub ustawia język.

SurveyListItem

Ta klasa reprezentuje pojedynczy element ankiety.

Nazwa Ścieżka Typ Opis
id
id integer

Identyfikator ankiety

nazwa
name string

Nazwa ankiety

modifiedDate
modifiedDate string

Data modyfikacji ankiety

data zakończenia
endDate string

Data zakończenia ankiety

isEndDateEnabled
isEndDateEnabled boolean

Jeśli dla tej ankiety jest włączona data zakończenia

stan
status SurveyStatus

SurveyStatus

archiveDate
archiveDate string

Data archiwizacji ankiety

statusOn
statusOn boolean

Czy ankieta jest włączona lub wyłączona

answers
answers integer

Pobiera lub ustawia odpowiedzi.

SurveyMetadataItem

Ta klasa reprezentuje pojedynczy element metadanych.

Nazwa Ścieżka Typ Opis
kod
code string

Pobiera lub ustawia kod.

typ danych
dataType string

Pobiera lub ustawia typ danych.

questionCode
questionCode string

Pobiera lub ustawia kod pytania.

typ
type string

Pobiera lub ustawia typ.

pytanie
question string

Pobiera lub ustawia pytanie.

szereg
row string

Pobiera lub ustawia wiersz.

choice
choice string

Pobiera lub ustawia wybór.

values
values array of RowItem

Pobiera lub ustawia wartości.

sectionName
sectionName string

Pobiera lub ustawia nazwę sekcji.

SurveyStatus

SurveyStatus

SurveyStatus

Blok tekstu

Blok tekstu

Nazwa Ścieżka Typ Opis
nazwa
name string

Pobiera lub ustawia nazwę.

typ
type string

Pobiera lub ustawia typ.

SMS
text array of TranslationElement

Pobiera lub ustawia tekst.

TextFieldSize

TextFieldSize

TextFieldSize

TranslationElement

Ta klasa reprezentuje tłumaczenie tekstu wewnątrz ankiety.

Nazwa Ścieżka Typ Opis
languageCode
languageCode string

Pobiera lub ustawia kod języka.

SMS
text string

Pobiera lub ustawia tekst.

UpdateMembersResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API UpdateMembers.

Nazwa Ścieżka Typ Opis
validationIssues
validationIssues array of WritePanelMemberIssue

Pobiera lub ustawia problemy.

czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

UpdateSurveyResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API UpdateSurvey.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

UpdateWebHookResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API CreateWebHook.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

ValueAssignmentType

ValueAssignmentType

ValueAssignmentType

VariableGroupElement

Ta klasa reprezentuje grupę pól w panelu.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

nazwa
name string

Pobiera lub ustawia nazwę.

nazwa wyświetlana
displayName string

Pobiera lub ustawia nazwę wyświetlaną.

pola
fields array of PanelFieldItem

Pobiera lub ustawia pola.

Typ zmiennej

Typ zmiennej

Typ zmiennej

Element webhookElement

Ta klasa reprezentuje pojedynczy element WebHook

Nazwa Ścieżka Typ Opis
id
id uuid

Pobiera lub ustawia identyfikator.

eventType
eventType EventType

Typ Wydarzenia

entityIdentifier
entityIdentifier string

Pobiera lub ustawia identyfikator jednostki.

createdAt
createdAt date-time

Pobiera lub ustawia utworzony element.

utworzone przez
createdBy string

Pobiera lub ustawia utworzone przez.

updatedAt
updatedAt date-time

Pobiera lub ustawia zaktualizowaną wartość.

zaktualizowanoPrzez
updatedBy string

Pobiera lub ustawia zaktualizowane przez.

Przepływ pracyTransition

Ta klasa reprezentuje jedno przejście z jednego stanu do drugiego.

Nazwa Ścieżka Typ Opis
nazwa
name string

Pobiera lub ustawia nazwę.

akcja
action string

Pobiera lub ustawia nazwę akcji.

newState
newState string

Tworzy nowy stan.

condition
condition string

Pobiera lub ustawia warunek.

WorkspaceDto

Ta klasa reprezentuje jedną jednostkę obszaru roboczego.

Nazwa Ścieżka Typ Opis
id
id integer

Pobiera lub ustawia identyfikator.

nazwa
name string

Pobiera lub ustawia nazwę.

numberOfSurveys
numberOfSurveys integer

Pobiera lub ustawia liczbę ankiet.

WriteOptOutListResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API WriteOptOutList.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

WritePanelMemberIssue

Reprezentują jakiś problem, który można wyświetlić

Nazwa Ścieżka Typ Opis
kod błędu
errorCode string

Pobiera lub ustawia kod błędu.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

WritePanelResponse

Ta klasa reprezentuje parametry zwracane dla interfejsu API WritePanel.

Nazwa Ścieżka Typ Opis
czySukces
isSuccess boolean

Pobiera lub ustawia wartość wskazującą, czy to wystąpienie jest pomyślne.

errorMessage
errorMessage string

Pobiera lub ustawia komunikat o błędzie.

kod błędu
errorCode string

Pobiera lub ustawia kod błędu.