Survalyzer UE (versão prévia)

O conector do Survalyzer fornece acesso simplificado a todos os recursos de API do data center da UE.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Centro de Desenvolvedores do Survalyzer
URL	https://developer.survalyzer.com/

Metadados do conector
Publicador	Survalyzer AG
Site da Web	https://survalyzer.com
Política de privacidade	https://survalyzer.com/privacy-policy
Categorias	Marketing; Produtividade

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
ID do cliente – Sua ClientId do Survalyzer	cadeia	Insira a ID do cliente.	Verdade
Segredo do cliente - Seu Survalyzer ClientSecret	secureString	Insira o segredo do cliente.	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar membros	Essa ação oferece a possibilidade de atualizar a lista de membros.
Atualizar o Web Hook	Essa ação oferece a possibilidade de atualizar o gancho da Web.
Atualizar Opt-Outs	Essa ação oferece a possibilidade de gravar entradas na lista de Opt-Out para um workspace.
Atualizar Pesquisa	Essa ação oferece a possibilidade de atualizar a pesquisa.
Baixar PDF de entrevista	Essa ação oferece a possibilidade de baixar as respostas.
Convidar Membros	Essa ação oferece a possibilidade de convidar o membro.
Convidar Membros	Essa ação oferece a possibilidade de criar e convidar membros.
Criar Artefato	Essa ação oferece a possibilidade de criar um novo artefato.
Criar Membros	Essa ação oferece a possibilidade de criar a lista de membros.
Criar painel ou exemplo	Essa ação oferece a possibilidade de criar um novo painel.
Criar Pesquisa	Essa ação oferece a possibilidade de criar uma pesquisa.
Criar WebHook	Essa ação oferece a possibilidade de criar o gancho da Web.
Código de incentivo de resgate	Essa ação oferece a possibilidade de gastar créditos de pesquisa para incentivos/vouchers.
Enviar Email	Essa ação oferece a possibilidade de enviar emails.
Excluir Artefato	Essa ação oferece a possibilidade de excluir o artefato.
Excluir Distribuidor	Essa ação oferece a possibilidade de excluir o distribuidor.
Excluir Entrevista	Essa ação oferece a possibilidade de excluir a entrevista.
Excluir Membros	Essa ação oferece a possibilidade de excluir membros.
Excluir Painel	Essa ação oferece a possibilidade de excluir o painel.
Excluir Pesquisa	Essa ação oferece a possibilidade de excluir a pesquisa.
Excluir projeto de amostragem	Essa ação oferece a possibilidade de excluir o projeto de amostragem.
Excluir WebHook	Essa ação oferece a possibilidade de excluir o gancho da Web.
Executar transição de fluxo de trabalho	Essa ação oferece a possibilidade de executar a transição de fluxo de trabalho específica para o fluxo de trabalho.
Lembrar Membros	Essa ação oferece a possibilidade de lembrar o membro.
Ler artefatos	Essa ação oferece a possibilidade de ler a lista de artefatos.
Ler Distribuidores	Essa ação oferece a possibilidade de ler a lista de distribuidores.
Ler entrevista	Essa ação oferece a possibilidade de ler os dados da entrevista.
Ler entrevistas	Essa ação oferece a possibilidade de ler a lista de entrevistas.
Ler Entrevistas Compactas	Essa ação oferece a possibilidade de ler o compacto da lista de entrevistas.
Ler incentivos	Essa ação retorna os incentivos/voucher disponíveis para o usuário autenticado.
Ler links da pesquisa	Essa ação oferece a possibilidade de ler os links da pesquisa.
Ler Membros	Essa ação oferece a possibilidade de ler membros.
Ler modelos de mensagem	Essa ação oferece a possibilidade de receber todos os modelos de mensagem configurados para Email e SMS.
Ler Opt-Outs	Essa ação oferece a possibilidade de ler todos os Opt-Outs para um workspace.
Ler Pesquisa	Essa ação oferece a possibilidade de ler a pesquisa.
Ler pesquisas	Essa ação oferece a possibilidade de ler todas as pesquisas disponíveis de um determinado workspace.
Ler projeto de amostragem	Essa ação oferece a possibilidade de ler o projeto de amostragem.
Ler Saldo de Crédito	Essa ação retorna o saldo de crédito da pesquisa para o usuário autenticado.
Ler saltos	Essa ação oferece a possibilidade de ler a lista de recuperação.
Ler transações de incentivo	A ação retorna uma visão geral sobre todos os ganhos e gastos relacionados aos créditos da pesquisa.
Ler transições de fluxo de trabalho	Essa ação oferece a possibilidade de ler todas as transições de fluxo de trabalho específicas para o fluxo de trabalho.
Ler WebHooks	Essa ação oferece a possibilidade de ler a lista de ganchos da Web.
Ler workspaces	Essa ação oferece a possibilidade de ler todos os workspaces disponíveis.
Painel de Atualização	Essa ação oferece a possibilidade de atualizar o painel.
Painel de Leitura	Essa ação oferece a possibilidade de ler a definição do painel.
Redefinir Entrevista	Essa ação oferece a possibilidade de redefinir a resposta do membro do painel.

Atualizar membros

ID da operação:: UpdateMembers

Essa ação oferece a possibilidade de atualizar a lista de membros.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
id	id		integer	Obtém ou define o identificador.
fields	fields	True	object	Obtém ou define os campos.
createdAt	createdAt		date-time	Obtém ou define o criado em.
createdBy	createdBy		string	Obtém ou define o criado por.
updatedAt	updatedAt		date-time	Obtém ou define a atualização em.
atualizadoPor	updatedBy		string	Obtém ou define a atualização por.
id	id		string	A ID da entrevista
estado	state		string	Obtém ou define o estado.
surveyId	surveyId		integer	A ID da pesquisa
surveyVersionId	surveyVersionId		integer	A ID da versão da pesquisa
surveyName	surveyName		string	O nome da pesquisa
surveyState	surveyState		string	Obtém ou define o estado da pesquisa.
answersLink	answersLink		string	O link para a página de impressão de respostas
interviewLink	interviewLink		string	Obtém ou define o link da entrevista.
startDate	startDate		string	Obtém ou define a data de início.
data de término	endDate		string	Obtém ou define a data de término.
samplingProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
distributorId	distributorId		integer	Obtém ou define o identificador do distribuidor.

Retornos

Essa classe representa os parâmetros de retorno para a API UpdateMembers.

Corpo: UpdateMembersResponse

Atualizar o Web Hook

ID da operação:: UpdateWebHook

Essa ação oferece a possibilidade de atualizar o gancho da Web.

Parâmetros

Nome	Chave	Tipo	Description
WebHookId	webHookId	uuid	Obtém ou define o identificador do web hook.
eventType	eventType	string	Tipo de Evento
entityIdentifier	entityIdentifier	string	Obtém ou define o identificador de entidade.
securityToken	securityToken	string	Obtém ou define o token de segurança.
WebHookUrl	webHookUrl	string	Obtém ou define a URL do web hook.

Retornos

Essa classe representa os parâmetros de retorno para a API CreateWebHook.

Corpo: UpdateWebHookResponse

Atualizar Opt-Outs

ID da operação:: WriteOptOutList

Essa ação oferece a possibilidade de gravar entradas na lista de Opt-Out para um workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do espaço de trabalho	workspaceId		integer	Obtém ou define o identificador do workspace.
panelId	panelId		integer	Obtém ou define o identificador do painel.
distributorId	distributorId		integer	Obtém ou define o identificador do distribuidor.
email	email	True	string	Obtém ou define o email.
optOutOperation	optOutOperation	True	string	OptOutOperation
celular	cellPhone	True	integer	Obtém ou define o celular.
optOutOperation	optOutOperation	True	string	OptOutOperation

Retornos

Essa classe representa os parâmetros de retorno para a API WriteOptOutList.

Corpo: WriteOptOutListResponse

Atualizar Pesquisa

ID da operação:: UpdateSurvey

Essa ação oferece a possibilidade de atualizar a pesquisa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.
surveyName	surveyName		string	Obtém ou define o nome da pesquisa.
allowMultipleParticipation	allowMultipleParticipation	True	boolean	Obtém ou define um valor que indica se [permitir várias participações].
allowNavigateBack	allowNavigateBack	True	boolean	Obtém ou define um valor que indica se [permitir navegar de volta].
allowSaveProgress	allowSaveProgress		boolean	Obtém ou define um valor que indica se [permitir o progresso de salvamento].
randomizeSections	randomizeSections	True	boolean	Obtém ou define um valor que indica se [randomizar seções].
enableAutoScroll	enableAutoScroll		boolean	Obtém ou define um valor que indica se [habilitar rolagem automática].
enableCodeAccess	enableCodeAccess		boolean	Obtém ou define um valor que indica se [habilitar o acesso ao código].
tipo de acesso	accessType		string	Tipo de Acesso
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
associatedPanels	associatedPanels		array of integer	Obtém ou define o identificador do painel.
codeAccessMode	codeAccessMode	True	string	AuthenticationType
enablePanelSync	enablePanelSync		boolean	Obtém ou define um valor que indica se [habilitar sincronização de painel].
panelSyncBehaviour	panelSyncBehaviour		string	PanelSyncBehaviour
identificador	identifier		string	Obtém ou define o identificador.
panelField	panelField		string	Obtém ou define o campo do painel.
defaultLanguage	defaultLanguage	True	string	Obtém ou define o idioma padrão.
data de término	endDate		date-time	Obtém ou define a data de término.
Idiomas	languages	True	array of string	Obtém ou define os idiomas.
id	id	True	integer	Obtém ou define o identificador.
nome	name	True	string	Obtém ou define o nome.
randomizePages	randomizePages	True	boolean	Obtém ou define um valor que indica se [randomizar páginas].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtém ou define um valor que indica se [excluir da randomização].
id	id	True	integer	Obtém ou define o identificador.
elementType	elementType	True	string	ElementType
codificar	code		string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
hasHintText	hasHintText		boolean	Obtém ou define um valor que indica se essa instância tem texto de dica.
hasNotAvailableChoice	hasNotAvailableChoice		boolean	Obtém ou define um valor que indica se essa instância não tem escolha disponível.
forceResponse	forceResponse		boolean	Obtém ou define um valor que indica se [forçar resposta].
id	id	True	integer	Obtém ou define o identificador.
codificar	code	True	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
allowTextEntry	allowTextEntry	True	boolean	Obtém ou define um valor que indica se [permitir entrada de texto].
forceInput	forceInput	True	boolean	Obtém ou define um valor que indica se [forçar entrada].
preenchimento automático	autocomplete	True	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.Choice é preenchimento automático.
exclusivo	exclusive	True	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.Choice é exclusivo.
excludeFromRandomization	excludeFromRandomization		boolean	Obtém ou define um valor que indica se [excluir da randomização].
validationType	validationType	True	string	Validação de conteúdo
earliestDate	earliestDate		string	Obtém ou define a data mais antiga.
latestDate	latestDate		string	Obtém ou define a data mais recente.
valor mínimo	minValue		double	Obtém ou define o valor mínimo.
valorMáximo	maxValue		double	Obtém ou define o valor máximo.
decimalPlaces	decimalPlaces		integer	Obtém ou define as casas decimais.
disableThousandSeparator	disableThousandSeparator		boolean	Obtém ou define o separador de milhares de desabilitados.
conditionAction	conditionAction	True	string	FilterAction
autocompleteListVariable	autocompleteListVariable		string	Obtém ou define a variável de lista de preenchimento automático.
randomizeChoices	randomizeChoices		boolean	Obtém ou define um valor que indica se [escolhas aleatórias].
columnType	columnType		string	TipoDeColuna
valor mínimo	minValue		integer	Obtém ou define o valor mínimo.
valorMáximo	maxValue		integer	Obtém ou define o valor máximo.
showCenterLabel	showCenterLabel		boolean	Obtém ou define um valor que indica se [mostrar rótulo central].
showValue	showValue		boolean	Obtém ou define um valor que indica se [mostrar valor].
maxDecimals	maxDecimals		integer	Obtém ou define os dígitos máximos após a vírgula.
textFieldSize	textFieldSize		string	TextFieldSize
preenchimento automático	autocomplete		boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.SurveyElement é preenchimento automático.
hasPlaceholder	hasPlaceholder		boolean	Obtém ou define um valor que indica se essa instância tem espaço reservado.
isPassword	isPassword		boolean	Obtém ou define um valor que indica se essa instância é senha.
minMaxValidation	minMaxValidation		boolean	Obtém ou define um valor que indica se [validação máxima mínima].
minimumCheckedChoices	minimumCheckedChoices		integer	Obtém ou define as opções mínimas marcadas.
maximumCheckedChoices	maximumCheckedChoices		integer	Obtém ou define o máximo de opções verificadas.
id	id	True	integer	Obtém ou define o identificador.
hasNotAvailableChoice	hasNotAvailableChoice	True	boolean	Obtém ou define um valor que indica se essa instância não tem escolha disponível.
randomizeColumns	randomizeColumns	True	boolean	Obtém ou define um valor que indica se [randomizar colunas].
choiceType	choiceType	True	string	ChoiceType
randomizeRows	randomizeRows		boolean	Obtém ou define um valor que indica se [randomizar linhas].
id	id	True	integer	Obtém ou define o identificador.
codificar	code	True	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtém ou define um valor que indica se [excluir da randomização].
numberOfRanks	numberOfRanks		integer	Obtém ou define o número de classificações.
hasStartText	hasStartText		boolean	Obtém ou define um valor que indica se essa instância tem texto inicial.
enableMeasurement	enableMeasurement		boolean	Obtém ou define um valor que indica se [habilitar medida].
showButtons	showButtons		boolean	Obtém ou define um valor que indica se [mostrar botões].
likeKey	likeKey		string	Obtém ou define a tecla like.
dislikeKey	dislikeKey		string	Obtém ou define a chave de antipatia.
interviewState	interviewState		string	Obtém ou define o estado da resposta.
actionType	actionType	True	string	QuotaAction
from	from		string	Obtém ou define o remetente.
para	to		string	Obtém ou define o receptor.
valueAssignmentType	valueAssignmentType		string	ValueAssignmentType
variableName	variableName		string	Obtém ou define o nome da variável.
executionBehavior	executionBehavior		string	ExecutionBehavior
apiCallMethod	apiCallMethod		string	ApiCallMethod
headers	headers		string	Obtém ou define os cabeçalhos.
externalUri	externalUri		string	Obtém ou define o URI externo.
scriptType	scriptType		string	ScriptType
conteúdo	content		string	Obtém ou define o conteúdo.
hasRatingLabels	hasRatingLabels		boolean	Obtém ou define um valor que indica se essa instância tem rótulos de classificação.
evaluateAsJson	evaluateAsJson		boolean	Obtém ou define um valor que indica se [avaliar como json].
autocompleteListVariable	autocompleteListVariable		string	Obtém ou define a variável de lista de preenchimento automático.
arrangementMode	arrangementMode		string	ArrangementMode
enableAnimation	enableAnimation		boolean	Obtém ou define um valor que indica se [habilitar animação].
useSmiley	useSmiley		boolean	Obtém ou define um valor que indica se [use smiley].
hasPrompt	hasPrompt		boolean	Obtém ou define um valor que indica se essa instância tem prompt.
id	id	True	integer	Obtém ou define o identificador.
variableName	variableName	True	string	Obtém ou define o nome da variável.
defaultTextOverrides	defaultTextOverrides		object	Obtém ou define as substituições de texto padrão.
surveyDesignLayout	surveyDesignLayout		integer	Obtém ou define o layout de design da pesquisa.
matrixSubQuestionSize	matrixSubQuestionSize		string	MatrixSubQuestionSize
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
anonymizingMode	anonymizingMode	True	string	AnonymizingMode
logIp	logIp	True	boolean	Obtém ou define um valor que indica se [ip de log].
logUserAgent	logUserAgent	True	boolean	Obtém ou define um valor que indica se [agente de usuário de log].
logReferer	logReferer	True	boolean	Obtém ou define um valor que indica se [referenciador de log].

Retornos

Essa classe representa os parâmetros de retorno para a API UpdateSurvey.

Corpo: UpdateSurveyResponse

Baixar PDF de entrevista

ID da operação:: DownloadInterviewPdf

Essa ação oferece a possibilidade de baixar as respostas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Inquilino	tenant	True	string	O locatário.
SurveyId	surveyId	True	integer	O identificador da pesquisa.
InterviewId	interviewId	True	uuid	O identificador da entrevista.
Mostrar Parcial Concluído	showPartialCompleted		boolean	se definido como <c>true</c> [mostrar parcial concluído].
Local	locale		string	A localidade.
Thmezone	timeZone		string	O fuso horário.
isCancellationRequested	isCancellationRequested		boolean
canBeCanceled	canBeCanceled		boolean
isInvalid	isInvalid		boolean
isClosed	isClosed		boolean

Retornos

Essa classe representa os parâmetros de retorno para a API DownloadAnswers.

Corpo: DownloadAnswersResponse

Convidar Membros

ID da operação:: InviteMembers

Essa ação oferece a possibilidade de convidar o membro.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
surveyId	surveyId	True	integer	A ID da pesquisa
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
samplingProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
memberIds	memberIds		array of integer	Obtém ou define as IDs de membros do painel.
messageTemplateId	messageTemplateId	True	integer	Obtém ou define o identificador de modelo de mensagem.
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
scheduleDateTime	scheduleDateTime		date-time	Obtém ou define a hora de agendamento.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
canal	channel		string	Canal de Distribuição
asyncProcess	asyncProcess		boolean	Obtém ou define o processo assíncrono.
interviewExpiryDate	interviewExpiryDate		string	Obtém ou define a data de expiração da entrevista.
from	from		string	Obtém ou define de.
fromName	fromName		string	Obtém ou define do nome.
replyTo	replyTo		string	Obtém ou define a resposta.
replyToName	replyToName		string	Obtém ou define o nome da resposta.

Retornos

Essa classe representa os parâmetros de retorno para a API InviteMembers.

Corpo: InviteMembersResponse

Convidar Membros

ID da operação:: CreateAndInviteMembers

Essa ação oferece a possibilidade de criar e convidar membros.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
samplingProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
canal	channel	True	string	Canal de Distribuição
messageTemplateId	messageTemplateId	True	integer	Obtém ou define o identificador de modelo de mensagem.
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
id	id		integer	Obtém ou define o identificador.
fields	fields	True	object	Obtém ou define os campos.
createdAt	createdAt		date-time	Obtém ou define o criado em.
createdBy	createdBy		string	Obtém ou define o criado por.
updatedAt	updatedAt		date-time	Obtém ou define a atualização em.
atualizadoPor	updatedBy		string	Obtém ou define a atualização por.
id	id		string	A ID da entrevista
estado	state		string	Obtém ou define o estado.
surveyId	surveyId		integer	A ID da pesquisa
surveyVersionId	surveyVersionId		integer	A ID da versão da pesquisa
surveyName	surveyName		string	O nome da pesquisa
surveyState	surveyState		string	Obtém ou define o estado da pesquisa.
answersLink	answersLink		string	O link para a página de impressão de respostas
interviewLink	interviewLink		string	Obtém ou define o link da entrevista.
startDate	startDate		string	Obtém ou define a data de início.
data de término	endDate		string	Obtém ou define a data de término.
samplingProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
distributorId	distributorId		integer	Obtém ou define o identificador do distribuidor.
scheduleDateTime	scheduleDateTime		string	Obtém ou define a data de agendamento.
asyncProcess	asyncProcess		boolean	Obtém ou define o processo assíncrono.
interviewExpiryDate	interviewExpiryDate		string	Obtém ou define a data de expiração da entrevista.
from	from		string	Obtém ou define de.
fromName	fromName		string	Obtém ou define do nome.
replyTo	replyTo		string	Obtém ou define a resposta.
replyToName	replyToName		string	Obtém ou define o nome da resposta.

Retornos

Essa classe representa os parâmetros de retorno para a API CreateAndInviteMembers.

Corpo: CreateAndInviteMembersResponse

Criar Artefato

ID da operação:: CreateArtifact

Essa ação oferece a possibilidade de criar um novo artefato.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do espaço de trabalho	workspaceId		integer	Obtém ou define o identificador do workspace.
caminho	path		string	Obtém ou define o caminho.

Retornos

Essa classe representa a resposta da API CreateArtifact.

Corpo: CreateArtifactResponse

Criar Membros

ID da operação:: CreateMembers

Essa ação oferece a possibilidade de criar a lista de membros.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
id	id		integer	Obtém ou define o identificador.
fields	fields	True	object	Obtém ou define os campos.
createdAt	createdAt		date-time	Obtém ou define o criado em.
createdBy	createdBy		string	Obtém ou define o criado por.
updatedAt	updatedAt		date-time	Obtém ou define a atualização em.
atualizadoPor	updatedBy		string	Obtém ou define a atualização por.
id	id		string	A ID da entrevista
estado	state		string	Obtém ou define o estado.
surveyId	surveyId		integer	A ID da pesquisa
surveyVersionId	surveyVersionId		integer	A ID da versão da pesquisa
surveyName	surveyName		string	O nome da pesquisa
surveyState	surveyState		string	Obtém ou define o estado da pesquisa.
answersLink	answersLink		string	O link para a página de impressão de respostas
interviewLink	interviewLink		string	Obtém ou define o link da entrevista.
startDate	startDate		string	Obtém ou define a data de início.
data de término	endDate		string	Obtém ou define a data de término.
samplingProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
distributorId	distributorId		integer	Obtém ou define o identificador do distribuidor.

Retornos

Essa classe representa os parâmetros de retorno para a API CreateMembers.

Corpo: CreateMembersResponse

Criar painel ou exemplo

ID da operação:: CreatePanel

Essa ação oferece a possibilidade de criar um novo painel.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do espaço de trabalho	workspaceId	True	integer	Obtém ou define o identificador do workspace.
nome	name	True	string	Obtém ou define o nome do painel.
panelType	panelType	True	string	PanelModelType

Retornos

Essa classe representa os parâmetros de retorno para a API CreatePanel.

Corpo: CreatePanelResponse

Criar Pesquisa

ID da operação:: CreateSurvey

Essa ação oferece a possibilidade de criar uma pesquisa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do espaço de trabalho	workspaceId	True	integer	Obtém ou define o identificador do workspace.
nome	name	True	string	Obtém ou define o nome.
allowMultipleParticipation	allowMultipleParticipation	True	boolean	Obtém ou define um valor que indica se [permitir várias participações].
allowNavigateBack	allowNavigateBack	True	boolean	Obtém ou define um valor que indica se [permitir navegar de volta].
allowSaveProgress	allowSaveProgress		boolean	Obtém ou define um valor que indica se [permitir o progresso de salvamento].
randomizeSections	randomizeSections	True	boolean	Obtém ou define um valor que indica se [randomizar seções].
enableAutoScroll	enableAutoScroll		boolean	Obtém ou define um valor que indica se [habilitar rolagem automática].
enableCodeAccess	enableCodeAccess		boolean	Obtém ou define um valor que indica se [habilitar o acesso ao código].
tipo de acesso	accessType		string	Tipo de Acesso
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
associatedPanels	associatedPanels		array of integer	Obtém ou define o identificador do painel.
codeAccessMode	codeAccessMode	True	string	AuthenticationType
enablePanelSync	enablePanelSync		boolean	Obtém ou define um valor que indica se [habilitar sincronização de painel].
panelSyncBehaviour	panelSyncBehaviour		string	PanelSyncBehaviour
identificador	identifier		string	Obtém ou define o identificador.
panelField	panelField		string	Obtém ou define o campo do painel.
defaultLanguage	defaultLanguage	True	string	Obtém ou define o idioma padrão.
data de término	endDate		date-time	Obtém ou define a data de término.
Idiomas	languages	True	array of string	Obtém ou define os idiomas.
id	id	True	integer	Obtém ou define o identificador.
nome	name	True	string	Obtém ou define o nome.
randomizePages	randomizePages	True	boolean	Obtém ou define um valor que indica se [randomizar páginas].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtém ou define um valor que indica se [excluir da randomização].
id	id	True	integer	Obtém ou define o identificador.
elementType	elementType	True	string	ElementType
codificar	code		string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
hasHintText	hasHintText		boolean	Obtém ou define um valor que indica se essa instância tem texto de dica.
hasNotAvailableChoice	hasNotAvailableChoice		boolean	Obtém ou define um valor que indica se essa instância não tem escolha disponível.
forceResponse	forceResponse		boolean	Obtém ou define um valor que indica se [forçar resposta].
id	id	True	integer	Obtém ou define o identificador.
codificar	code	True	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
allowTextEntry	allowTextEntry	True	boolean	Obtém ou define um valor que indica se [permitir entrada de texto].
forceInput	forceInput	True	boolean	Obtém ou define um valor que indica se [forçar entrada].
preenchimento automático	autocomplete	True	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.Choice é preenchimento automático.
exclusivo	exclusive	True	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.Choice é exclusivo.
excludeFromRandomization	excludeFromRandomization		boolean	Obtém ou define um valor que indica se [excluir da randomização].
validationType	validationType	True	string	Validação de conteúdo
earliestDate	earliestDate		string	Obtém ou define a data mais antiga.
latestDate	latestDate		string	Obtém ou define a data mais recente.
valor mínimo	minValue		double	Obtém ou define o valor mínimo.
valorMáximo	maxValue		double	Obtém ou define o valor máximo.
decimalPlaces	decimalPlaces		integer	Obtém ou define as casas decimais.
disableThousandSeparator	disableThousandSeparator		boolean	Obtém ou define o separador de milhares de desabilitados.
conditionAction	conditionAction	True	string	FilterAction
autocompleteListVariable	autocompleteListVariable		string	Obtém ou define a variável de lista de preenchimento automático.
randomizeChoices	randomizeChoices		boolean	Obtém ou define um valor que indica se [escolhas aleatórias].
columnType	columnType		string	TipoDeColuna
valor mínimo	minValue		integer	Obtém ou define o valor mínimo.
valorMáximo	maxValue		integer	Obtém ou define o valor máximo.
showCenterLabel	showCenterLabel		boolean	Obtém ou define um valor que indica se [mostrar rótulo central].
showValue	showValue		boolean	Obtém ou define um valor que indica se [mostrar valor].
maxDecimals	maxDecimals		integer	Obtém ou define os dígitos máximos após a vírgula.
textFieldSize	textFieldSize		string	TextFieldSize
preenchimento automático	autocomplete		boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.SurveyElement é preenchimento automático.
hasPlaceholder	hasPlaceholder		boolean	Obtém ou define um valor que indica se essa instância tem espaço reservado.
isPassword	isPassword		boolean	Obtém ou define um valor que indica se essa instância é senha.
minMaxValidation	minMaxValidation		boolean	Obtém ou define um valor que indica se [validação máxima mínima].
minimumCheckedChoices	minimumCheckedChoices		integer	Obtém ou define as opções mínimas marcadas.
maximumCheckedChoices	maximumCheckedChoices		integer	Obtém ou define o máximo de opções verificadas.
id	id	True	integer	Obtém ou define o identificador.
hasNotAvailableChoice	hasNotAvailableChoice	True	boolean	Obtém ou define um valor que indica se essa instância não tem escolha disponível.
randomizeColumns	randomizeColumns	True	boolean	Obtém ou define um valor que indica se [randomizar colunas].
choiceType	choiceType	True	string	ChoiceType
randomizeRows	randomizeRows		boolean	Obtém ou define um valor que indica se [randomizar linhas].
id	id	True	integer	Obtém ou define o identificador.
codificar	code	True	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtém ou define um valor que indica se [excluir da randomização].
numberOfRanks	numberOfRanks		integer	Obtém ou define o número de classificações.
hasStartText	hasStartText		boolean	Obtém ou define um valor que indica se essa instância tem texto inicial.
enableMeasurement	enableMeasurement		boolean	Obtém ou define um valor que indica se [habilitar medida].
showButtons	showButtons		boolean	Obtém ou define um valor que indica se [mostrar botões].
likeKey	likeKey		string	Obtém ou define a tecla like.
dislikeKey	dislikeKey		string	Obtém ou define a chave de antipatia.
interviewState	interviewState		string	Obtém ou define o estado da resposta.
actionType	actionType	True	string	QuotaAction
from	from		string	Obtém ou define o remetente.
para	to		string	Obtém ou define o receptor.
valueAssignmentType	valueAssignmentType		string	ValueAssignmentType
variableName	variableName		string	Obtém ou define o nome da variável.
executionBehavior	executionBehavior		string	ExecutionBehavior
apiCallMethod	apiCallMethod		string	ApiCallMethod
headers	headers		string	Obtém ou define os cabeçalhos.
externalUri	externalUri		string	Obtém ou define o URI externo.
scriptType	scriptType		string	ScriptType
conteúdo	content		string	Obtém ou define o conteúdo.
hasRatingLabels	hasRatingLabels		boolean	Obtém ou define um valor que indica se essa instância tem rótulos de classificação.
evaluateAsJson	evaluateAsJson		boolean	Obtém ou define um valor que indica se [avaliar como json].
autocompleteListVariable	autocompleteListVariable		string	Obtém ou define a variável de lista de preenchimento automático.
arrangementMode	arrangementMode		string	ArrangementMode
enableAnimation	enableAnimation		boolean	Obtém ou define um valor que indica se [habilitar animação].
useSmiley	useSmiley		boolean	Obtém ou define um valor que indica se [use smiley].
hasPrompt	hasPrompt		boolean	Obtém ou define um valor que indica se essa instância tem prompt.
id	id	True	integer	Obtém ou define o identificador.
variableName	variableName	True	string	Obtém ou define o nome da variável.
defaultTextOverrides	defaultTextOverrides		object	Obtém ou define as substituições de texto padrão.
surveyDesignLayout	surveyDesignLayout		integer	Obtém ou define o layout de design da pesquisa.
matrixSubQuestionSize	matrixSubQuestionSize		string	MatrixSubQuestionSize
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
anonymizingMode	anonymizingMode	True	string	AnonymizingMode
logIp	logIp	True	boolean	Obtém ou define um valor que indica se [ip de log].
logUserAgent	logUserAgent	True	boolean	Obtém ou define um valor que indica se [agente de usuário de log].
logReferer	logReferer	True	boolean	Obtém ou define um valor que indica se [referenciador de log].

Retornos

Essa classe representa os parâmetros de retorno para a API CreateSurvey.

Corpo: CreateSurveyResponse

Criar WebHook

ID da operação:: CreateWebHook

Essa ação oferece a possibilidade de criar o gancho da Web.

Parâmetros

Nome	Chave	Tipo	Description
eventType	eventType	string	Tipo de Evento
entityIdentifier	entityIdentifier	string	Obtém ou define o identificador de entidade.
securityToken	securityToken	string	Obtém ou define o token de segurança.
WebHookUrl	webHookUrl	string	Obtém ou define a URL do web hook.

Retornos

Essa classe representa os parâmetros de retorno para a API CreateWebHook.

Corpo: CreateWebHookResponse

Código de incentivo de resgate

ID da operação:: RedeemIncentiveCode

Essa ação oferece a possibilidade de gastar créditos de pesquisa para incentivos/vouchers.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
incentiveId	incentiveId	True	integer	Obtém ou define o identificador de incentivo.

Retornos

Essa classe representa os parâmetros de retorno para a API RedeemIncentiveCode.

Corpo: RedeemIncentiveCodeResponse

Enviar Email

ID da operação:: ExecuteSendMail

Essa ação oferece a possibilidade de enviar emails.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
messageTemplateId	messageTemplateId		integer	Obtém ou define o identificador de modelo de mensagem.
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
linguagem	language	True	string	Obtém ou define o idioma.
assunto	subject		string	Obtém ou define o assunto.
body	body		string	Obtém ou define o corpo.
from	from	True	string	Obtém ou define de.
fromName	fromName		string	Obtém ou define do nome.
para	to	True	string	Obtém ou define para.
toName	toName		string	Converte em nome.
replyTo	replyTo		string	Obtém ou define a resposta.
replyToName	replyToName		string	Obtém ou define o nome da resposta.

Retornos

Essa classe representa os parâmetros de retorno para a API ExecuteSendMail.

Corpo: ExecuteSendMailResponse

Excluir Artefato

ID da operação:: DeleteArtifact

Essa ação oferece a possibilidade de excluir o artefato.

Parâmetros

Nome	Chave	Tipo	Description
caminho	path	string	Obtém ou define o caminho.
filename	filename	string	Obtém ou define o nome do arquivo.
ID do espaço de trabalho	workspaceId	integer	Obtém ou define o identificador do workspace.

Retornos

Essa classe representa os parâmetros de retorno para a API DeleteArtifact.

Corpo: DeleteArtifactResponse

Excluir Distribuidor

ID da operação:: DeleteDistributor

Essa ação oferece a possibilidade de excluir o distribuidor.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
distributorId	distributorId	True	integer	Obtém ou define o identificador do distribuidor.
keepInterviews	keepInterviews		boolean	Obtém ou define um valor que indica se [manter entrevistas].

Retornos

Essa classe representa os parâmetros de retorno para a API DeleteDistributor.

Corpo: DeleteDistributorResponse

Excluir Entrevista

ID da operação:: DeleteInterview

Essa ação oferece a possibilidade de excluir a entrevista.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
interviewId	interviewId		uuid	Obtém ou define o identificador de entrevista.
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.

Retornos

Essa classe representa os parâmetros de retorno para a API DeleteInterview.

Corpo: DeleteInterviewResponse

Excluir Membros

ID da operação:: DeleteMembers

Essa ação oferece a possibilidade de excluir membros.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
panelMembersIds	panelMembersIds	True	array of integer	Obtém ou define o identificador de membro do painel.
keepInterviews	keepInterviews		boolean	Obtém ou define um valor que indica se [manter entrevistas].

Retornos

Essa classe representa os parâmetros de retorno para a API DeleteMember.

Corpo: DeleteMembersResponse

Excluir Painel

ID da operação:: DeletePanel

Essa ação oferece a possibilidade de excluir o painel.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
panelId	panelId	True	integer	Obtém ou define o identificador de exemplo.
keepInterviews	keepInterviews		boolean	Obtém ou define um valor que indica se [manter entrevistas].

Retornos

Essa classe representa os parâmetros de retorno para a API DeleteSample.

Corpo: DeletePanelResponse

Excluir Pesquisa

ID da operação:: DeleteSurvey

Essa ação oferece a possibilidade de excluir a pesquisa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.

Retornos

Essa classe representa os parâmetros de retorno para a API DeleteSurvey.

Corpo: DeleteSurveyResponse

Excluir projeto de amostragem

ID da operação:: DeleteSamplingProject

Essa ação oferece a possibilidade de excluir o projeto de amostragem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
samplingProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
keepInterviews	keepInterviews		boolean	Obtém ou define um valor que indica se [manter entrevistas].

Retornos

Essa classe representa os parâmetros de retorno para a API DeleteSamplingProject.

Corpo: DeleteSamplingProjectResponse

Excluir WebHook

ID da operação:: DeleteWebHook

Essa ação oferece a possibilidade de excluir o gancho da Web.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
WebHookId	webHookId		uuid	Obtém ou define o identificador do web hook.

Retornos

Essa classe representa os parâmetros de retorno para a API DeleteWebHook.

Corpo: DeleteWebHookResponse

Executar transição de fluxo de trabalho

ID da operação:: ExecuteWorkflowTransition

Essa ação oferece a possibilidade de executar a transição de fluxo de trabalho específica para o fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
fluxo de trabalho	workflow	True	string	Tipo de fluxo de trabalho
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
samplingProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
distributorId	distributorId		integer	Obtém ou define o identificador do distribuidor.
reminderId	reminderId		integer	Obtém ou define o identificador de lembrete.
targetState	targetState	True	string	Obtém ou define o estado do destino.
dynamicParameters	dynamicParameters		object	Obtém ou define os parâmetros dinâmicos.

Retornos

Essa classe representa os parâmetros de retorno para a API ExecuteWorkflowTransition.

Corpo: ExecuteWorkflowTransitionResponse

Lembrar Membros

ID da operação:: RemindMembers

Essa ação oferece a possibilidade de lembrar o membro.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
distributorId	distributorId	True	integer	A ID da pesquisa
messageTemplateId	messageTemplateId	True	integer	Obtém ou define o identificador de modelo de mensagem.
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
scheduleDateTime	scheduleDateTime		date-time	Obtém ou define a hora de agendamento.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
canal	channel		string	Canal de Distribuição
from	from		string	Obtém ou define de.
fromName	fromName		string	Obtém ou define do nome.
replyTo	replyTo		string	Obtém ou define a resposta.
replyToName	replyToName		string	Obtém ou define o nome da resposta.

Retornos

Essa classe representa os parâmetros de retorno para a API RemindMembers.

Corpo: RemindMembersResponse

Ler artefatos

ID da operação:: ReadArtifactList

Essa ação oferece a possibilidade de ler a lista de artefatos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
caminho	path		string	Obtém ou define o caminho.
ID do espaço de trabalho	workspaceId		integer	Obtém ou define o identificador do workspace.

Retornos

Essa classe representa os parâmetros de solicitação para a API ReadArtifactList.

Corpo: ReadArtifactListRequest

Ler Distribuidores

ID da operação:: ReadDistributorList

Essa ação oferece a possibilidade de ler a lista de distribuidores.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
panelId	panelId		integer	Obtém ou define o identificador do painel.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de retorno para a API ReadDistributorList.

Corpo: ReadDistributorListResponse

Ler entrevista

ID da operação:: ReadInterview

Essa ação oferece a possibilidade de ler os dados da entrevista.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant	True	string	Obtém ou define o locatário.
interviewId	interviewId	True	uuid	Obtém ou define o identificador de entrevista.
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.
loadSurveyDefinition	loadSurveyDefinition		boolean	Obtém ou define um valor que indica se [definição de pesquisa de carga].

Retornos

Essa classe representa os parâmetros de retorno para a API ReadInterviewData.

Corpo: ReadInterviewDataResponse

Ler entrevistas

ID da operação:: ReadInterviewList

Essa ação oferece a possibilidade de ler a lista de entrevistas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant		string	Obtém ou define o locatário.
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
fieldsToDownload	fieldsToDownload		array of string	Obtém ou define as colunas solicitadas.
loadCodePlan	loadCodePlan		boolean	Obtém ou define um valor que indica se [plano de código de carga].
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de retorno para a API ReadInterviewList.

Corpo: ReadInterviewListResponseV3

Ler Entrevistas Compactas

ID da operação:: ReadInterviewListCompact

Essa ação oferece a possibilidade de ler o compacto da lista de entrevistas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant		string	Obtém ou define o locatário.
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
fieldsToDownload	fieldsToDownload		array of string	Obtém ou define as colunas solicitadas.
loadCodePlan	loadCodePlan		boolean	Obtém ou define um valor que indica se [plano de código de carga].
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de retorno para a API ReadInterviewListCompact.

Corpo: ReadInterviewListCompactResponseV3

Ler incentivos

ID da operação:: ReadIncentiveList

Essa ação retorna os incentivos/voucher disponíveis para o usuário autenticado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de solicitação para a API ReadIncentiveList.

Corpo: ReadIncentiveListResponse

Ler links da pesquisa

ID da operação:: ReadSurveyLinks

Essa ação oferece a possibilidade de ler os links da pesquisa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.

Retornos

Essa classe representa a resposta da API ReadSurveyLinks.

Corpo: ReadSurveyLinksResponse

Ler Membros

ID da operação:: ReadMemberList

Essa ação oferece a possibilidade de ler membros.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
interviewsRequired	interviewsRequired	True	boolean	Obtém ou define um valor que indica se as informações da sessão são necessárias.
fieldsToDownload	fieldsToDownload		array of string	Obtém ou define os campos a serem baixados.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de retorno para a API ReadMemberList.

Corpo: ReadMemberListResponse

Ler modelos de mensagem

ID da operação:: ReadMessageTemplateList

Essa ação oferece a possibilidade de receber todos os modelos de mensagem configurados para Email e SMS.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do espaço de trabalho	workspaceId		integer	Obtém ou define o identificador do workspace.
linguagem	language	True	string	Obtém ou define o idioma.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de retorno para a API ReadMessageTemplateList.

Corpo: ReadMessageTemplateListResponse

Ler Opt-Outs

ID da operação:: ReadOptOutList

Essa ação oferece a possibilidade de ler todos os Opt-Outs para um workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
panelId	panelId		integer	Obtém ou define o identificador do painel.
ID do espaço de trabalho	workspaceId		integer	Obtém ou define o identificador do workspace.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de retorno para a API ReadOptOutList.

Corpo: ReadOptOutListResponseV3

Ler Pesquisa

ID da operação:: ReadSurvey

Essa ação oferece a possibilidade de ler a pesquisa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant		string	Obtém ou define o locatário.
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.

Retornos

Essa classe representa os parâmetros de retorno para a API ReadSurveyDefinition.

Corpo: ReadSurveyResponse

Ler pesquisas

ID da operação:: ReadSurveyList

Essa ação oferece a possibilidade de ler todas as pesquisas disponíveis de um determinado workspace.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do espaço de trabalho	workspaceId	True	integer	Obtém ou define o identificador do workspace.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de resposta para a API ReadSurveyList.

Corpo: ReadSurveyListResponse

Ler projeto de amostragem

ID da operação:: ReadSamplingProject

Essa ação oferece a possibilidade de ler o projeto de amostragem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
samplingProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.

Retornos

Essa classe representa os parâmetros de retorno para a API ReadSamplingProject.

Corpo: ReadSamplingProjectResponse

Ler Saldo de Crédito

ID da operação:: ReadCreditBalance

Essa ação retorna o saldo de crédito da pesquisa para o usuário autenticado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
			object	Essa classe representa os parâmetros de solicitação para a API ReadCreditBalance.

Retornos

Essa classe representa os parâmetros de retorno para a API ReadCreditBalance.

Corpo: ReadCreditBalanceResponse

Ler saltos

ID da operação:: ReadBounceList

Essa ação oferece a possibilidade de ler a lista de recuperação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.
panelId	panelId		integer	Obtém ou define o identificador do painel.
Distribuidores	distributors		array of integer	Obtém ou define os distribuidores.
invitationType	invitationType		string	InvitationType
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de retorno para a API ReadBounceList.

Corpo: ReadBounceListResponseV3

Ler transações de incentivo

ID da operação:: ReadIncentiveTransactionList

A ação retorna uma visão geral sobre todos os ganhos e gastos relacionados aos créditos da pesquisa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de retorno para a API ReadIncentiveTransactionList.

Corpo: ReadIncentiveTransactionListResponse

Ler transições de fluxo de trabalho

ID da operação:: ReadWorkflowTransitions

Essa ação oferece a possibilidade de ler todas as transições de fluxo de trabalho específicas para o fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
fluxo de trabalho	workflow	True	string	Tipo de fluxo de trabalho
currentState	currentState	True	string	Obtém ou define o estado da corrente.

Retornos

Essa classe representa os parâmetros de retorno para a API ReadWorkflowTransitions.

Corpo: ReadWorkflowTransitionsResponse

Ler WebHooks

ID da operação:: ReadWebHookList

Essa ação oferece a possibilidade de ler a lista de ganchos da Web.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
eventType	eventType		string	Tipo de Evento
entityIdentifier	entityIdentifier		string	Obtém ou define o identificador de entidade.

Retornos

Essa classe representa os parâmetros de retorno para a API ReadWebHookList.

Corpo: ReadWebHookListResponse

Ler workspaces

ID da operação:: ReadWorkspaceList

Essa ação oferece a possibilidade de ler todos os workspaces disponíveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtém ou define o valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Retornos

Essa classe representa os parâmetros de solicitação para a API ReadWorkspaceList.

Corpo: ReadWorkspaceListResponse

Painel de Atualização

ID da operação:: UpdatePanel

Essa ação oferece a possibilidade de atualizar o painel.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
id	id		integer	A ID do campo. Esse é um campo obrigatório em caso de renomeação.
nome	name		string	O nome do campo. Esse campo é obrigatório.
tipo	type		string	PanelMemberFieldType
value	value			O valor do campo . O tipo de valor deve corresponder à propriedade Type.
removedFields	removedFields		array of integer	Obtém ou define os campos removidos.
id	id		integer	A ID do campo. Esse é um campo obrigatório em caso de renomeação.
nome	name		string	O nome do campo. Esse campo é obrigatório.
tipo	type		string	PanelMemberFieldType
value	value			O valor do campo . O tipo de valor deve corresponder à propriedade Type.

Retornos

Essa classe representa os parâmetros de retorno para a API WritePanel.

Corpo: WritePanelResponse

Painel de Leitura

ID da operação:: ReadPanel

Essa ação oferece a possibilidade de ler a definição do painel.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
locatário	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.

Retornos

Essa classe representa os parâmetros de retorno para a API ReadPanelDefinition.

Corpo: ReadPanelDefinitionResponse

Redefinir Entrevista

ID da operação:: ResetInterview

Essa ação oferece a possibilidade de redefinir a resposta do membro do painel.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
interviewId	interviewId		uuid	Obtém ou define o identificador de entrevista.

Retornos

Essa classe representa os parâmetros de retorno para a API ResetInterview.

Corpo: ResetInterviewResponse

Definições

Tipo de Acesso

: string

ActionElement

Essa classe representa um fim da ação de pesquisa para completo/screenout/cota completa.

Nome	Caminho	Tipo	Description
actionType	actionType	ActionType	QuotaAction
endOfSurveyText	endOfSurveyText	array of TranslationElement	Obtém ou define o final do texto da pesquisa.
forwardUrl	forwardUrl	array of TranslationElement	Obtém ou define a URL de encaminhamento.

Tipo de Ação

QuotaAction

: string

AnonymizingConfiguration

Essa classe contém as configurações de anonimização que podem ser aplicadas a um grupo de workspaces, a um workspace ou a uma pesquisa individual.

Nome	Caminho	Tipo	Description
anonymizingMode	anonymizingMode	AnonymizingMode	AnonymizingMode
logIp	logIp	boolean	Obtém ou define um valor que indica se [ip de log].
logUserAgent	logUserAgent	boolean	Obtém ou define um valor que indica se [agente de usuário de log].
logReferer	logReferer	boolean	Obtém ou define um valor que indica se [referenciador de log].

BounceElement

Essa classe representa um fim da ação de pesquisa para completo/screenout/cota completa.

Nome	Caminho	Tipo	Description
distributorId	distributorId	integer	Obtém ou define o identificador do distribuidor.
interviewId	interviewId	uuid	Obtém ou define o identificador de entrevista.
panelId	panelId	integer	Obtém ou define o identificador do painel.
panelMemberId	panelMemberId	integer	Obtém ou define o identificador de membro do painel.
bounceType	bounceType	BounceType	BounceType
carimbo de data/hora	timestamp	date-time	Obtém ou define o carimbo de data/hora.
estado	state	string	Obtém ou define o estado.
reason	reason	string	Obtém ou define o motivo.
email	email	string	Obtém ou define o email.
phone	phone	integer	Obtém ou define o telefone.
invitationType	invitationType	InvitationType	InvitationType

BounceType

: string

Opção

Essa classe representa uma única opção que pode ser usada em cada tipo de pergunta de escolha.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
codificar	code	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
enviar SMS	text	array of TranslationElement	Obtém ou define as traduções de texto.
allowTextEntry	allowTextEntry	boolean	Obtém ou define um valor que indica se [permitir entrada de texto].
forceInput	forceInput	boolean	Obtém ou define um valor que indica se [forçar entrada].
preenchimento automático	autocomplete	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.Choice é preenchimento automático.
autocompleteText	autocompleteText	array of TranslationElement	Obtém ou define as traduções de texto de preenchimento automático.
exclusivo	exclusive	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.Choice é exclusivo.
excludeFromRandomization	excludeFromRandomization	boolean	Obtém ou define um valor que indica se [excluir da randomização].
contentValidation	contentValidation	ContentValidation	Essa classe representa uma validação de conteúdo dentro de uma pesquisa.
condition	condition	ConditionDefinition	Essa classe representa a definição de elementos de condições.
autocompleteListVariable	autocompleteListVariable	string	Obtém ou define a variável de lista de preenchimento automático.

ChoiceType

: string

CodeAccessMode

AuthenticationType

: string

ColItem

Essa classe representa uma célula de uma resposta de pesquisa.

Nome	Caminho	Tipo	Description
id	id	string	Obtém ou define o identificador.
value	value		Obtém ou define o valor.

ColumnGroup

Essa classe representa um grupo de colunas dentro de tipos de pergunta complexos, como perguntas de matriz.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
enviar SMS	text	array of TranslationElement	Obtém ou define as traduções de texto.
hasNotAvailableChoice	hasNotAvailableChoice	boolean	Obtém ou define um valor que indica se essa instância não tem escolha disponível.
notAvailableChoiceText	notAvailableChoiceText	array of TranslationElement	Obtém ou define as traduções de texto de opção não disponíveis.
randomizeColumns	randomizeColumns	boolean	Obtém ou define um valor que indica se [randomizar colunas].
solicitação	prompt	array of TranslationElement	Obtém ou define o prompt.
choiceType	choiceType	ChoiceType	ChoiceType
choices	choices	array of Choice	Obtém ou define as opções.
condition	condition	ConditionDefinition	Essa classe representa a definição de elementos de condições.

TipoDeColuna

: string

Condição

Essa classe é a base para todos os elementos de condição.

Nome	Caminho	Tipo	Description
conjunção	conjunction	Conjunction	Conjunção
conditionType	conditionType	ConditionType	ConditionType
identificador	identifier	string	Obtém ou define o identificador.
conditionOperator	conditionOperator	ConditionOperator	ConditionOperator
value	value	string	Obtém ou define o valor.
variableType	variableType	VariableType	VariableType
jsonValue	jsonValue	boolean	Obtém ou define um valor que indica se [valor json].
jsonPath	jsonPath	string	Obtém ou define o caminho json.

ConditionAction

FilterAction

: string

ConditionDefinition

Essa classe representa a definição de elementos de condições.

Nome	Caminho	Tipo	Description
conditionAction	conditionAction	ConditionAction	FilterAction
Elementos	elements	array of Condition	Obtém ou define os elementos.

ConditionOperator

: string

ConditionType

: string

Conjunção

: string

Validação de conteúdo

Essa classe representa uma validação de conteúdo dentro de uma pesquisa.

Nome	Caminho	Tipo	Description
validationType	validationType	ContentValidationType	Validação de conteúdo
earliestDate	earliestDate	string	Obtém ou define a data mais antiga.
latestDate	latestDate	string	Obtém ou define a data mais recente.
valor mínimo	minValue	double	Obtém ou define o valor mínimo.
valorMáximo	maxValue	double	Obtém ou define o valor máximo.
decimalPlaces	decimalPlaces	integer	Obtém ou define as casas decimais.
disableThousandSeparator	disableThousandSeparator	boolean	Obtém ou define o separador de milhares de desabilitados.

ContentValidationType

Validação de conteúdo

: string

CreateAndInviteMembersResponse

Essa classe representa os parâmetros de retorno para a API CreateAndInviteMembers.

Nome	Caminho	Tipo	Description
samplingProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
distributorId	distributorId	integer	Obtém ou define o identificador do distribuidor.
validationIssues	validationIssues	array of WritePanelMemberIssue	Obtém ou define os problemas.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreateArtifactResponse

Essa classe representa a resposta da API CreateArtifact.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreateMembersResponse

Essa classe representa os parâmetros de retorno para a API CreateMembers.

Nome	Caminho	Tipo	Description
membersIds	membersIds	array of integer	Obtém ou define as IDs de membros.
validationIssues	validationIssues	array of WritePanelMemberIssue	Obtém ou define os problemas.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreatePanelResponse

Essa classe representa os parâmetros de retorno para a API CreatePanel.

Nome	Caminho	Tipo	Description
id	id	integer	Obtenha a ID do painel criado.
nome	name	string	Obtenha o nome do painel criado.
isExtendedPanel	isExtendedPanel	boolean	Obtenha o tipo de painel criado.
createdDate	createdDate	string	Obtenha a data de criação do painel criado.
isLock	isLock	boolean	Obtenha o valor que indica se o painel está bloqueado.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreateSurveyResponse

Essa classe representa os parâmetros de retorno para a API CreateSurvey.

Nome	Caminho	Tipo	Description
surveyId	surveyId	integer	Obtém ou define o identificador da pesquisa.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreateWebHookResponse

Essa classe representa os parâmetros de retorno para a API CreateWebHook.

Nome	Caminho	Tipo	Description
WebHookId	webHookId	uuid	Obtém ou define o identificador do web hook.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CustomVariable

Essa classe representa uma única variável personalizada.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
variableName	variableName	string	Obtém ou define o nome da variável.
variableType	variableType	VariableType	VariableType

DataAccessControl

Essa classe contém a configuração de como a entidade está sendo acessível

Nome	Caminho	Tipo	Description
tipo de acesso	accessType	AccessType	Tipo de Acesso
conditions	conditions	array of Condition	Obtém ou define as condições.

DeleteArtifactResponse

Essa classe representa os parâmetros de retorno para a API DeleteArtifact.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteDistributorResponse

Essa classe representa os parâmetros de retorno para a API DeleteDistributor.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteInterviewResponse

Essa classe representa os parâmetros de retorno para a API DeleteInterview.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteMembersResponse

Essa classe representa os parâmetros de retorno para a API DeleteMember.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeletePanelResponse

Essa classe representa os parâmetros de retorno para a API DeleteSample.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteSamplingProjectResponse

Essa classe representa os parâmetros de retorno para a API DeleteSamplingProject.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteSurveyResponse

Essa classe representa os parâmetros de retorno para a API DeleteSurvey.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteWebHookResponse

Essa classe representa os parâmetros de retorno para a API DeleteWebHook.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DesignConfiguration

Essa classe representa as possibilidades de estilo de uma conta.

Nome	Caminho	Tipo	Description
surveyDesignLayout	surveyDesignLayout	integer	Obtém ou define o layout de design da pesquisa.
matrixSubQuestionSize	matrixSubQuestionSize	MatrixSubQuestionSize	MatrixSubQuestionSize
textBlocks	textBlocks	array of TextBlock	Obtém ou define o conteúdo do modelo.

DistributionChannel

Canal de Distribuição

: string

DistributorElement

Essa classe representa um elemento distribuidor.

Nome	Caminho	Tipo	Description
distributorId	distributorId	integer	Obtém ou define o identificador do distribuidor.
distributionChannel	distributionChannel	DistributionChannel	Canal de Distribuição
surveyId	surveyId	integer	Obtém ou define o identificador da pesquisa.
samplingProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
surveyVersion	surveyVersion	integer	Obtém ou define a versão da pesquisa.
panelId	panelId	integer	Obtém ou define o identificador do painel.
scheduledDistribution	scheduledDistribution	date-time	Obtém ou define a distribuição agendada.
executedDistribution	executedDistribution	date-time	Obtém ou define a distribuição executada.
distributionState	distributionState	string	Obtém ou define o estado da distribuição.
conditions	conditions	array of ConditionDefinition	Obtém ou define as condições.

DownloadAnswersResponse

Essa classe representa os parâmetros de retorno para a API DownloadAnswers.

Nome	Caminho	Tipo	Description
url de download	downloadUrl	string	Obtém ou define a URL de download.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ElementType

: string

Tipo de Evento

: string

ExecuteSendMailResponse

Essa classe representa os parâmetros de retorno para a API ExecuteSendMail.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ExecuteWorkflowTransitionResponse

Essa classe representa os parâmetros de retorno para a API ExecuteWorkflowTransition.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ExecutionBehavior

: string

Entrevista

Essa classe representa dados de registro de entrevista

Nome	Caminho	Tipo	Description
id	id	string	A ID da entrevista
estado	state	string	Obtém ou define o estado.
surveyId	surveyId	integer	A ID da pesquisa
surveyVersionId	surveyVersionId	integer	A ID da versão da pesquisa
surveyName	surveyName	string	O nome da pesquisa
surveyState	surveyState	string	Obtém ou define o estado da pesquisa.
answersLink	answersLink	string	O link para a página de impressão de respostas
interviewLink	interviewLink	string	Obtém ou define o link da entrevista.
startDate	startDate	string	Obtém ou define a data de início.
data de término	endDate	string	Obtém ou define a data de término.
samplingProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
distributorId	distributorId	integer	Obtém ou define o identificador do distribuidor.

InvitationType

: string

InviteMembersResponse

Essa classe representa os parâmetros de retorno para a API InviteMembers.

Nome	Caminho	Tipo	Description
samplingProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
distributorId	distributorId	integer	Obtém ou define o identificador do distribuidor.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

MatrixSubQuestionSize

: string

Membro

Essa classe representa um único membro do painel com uma estrutura dinâmica baseada no Painel.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
fields	fields	object	Obtém ou define os campos.
createdAt	createdAt	date-time	Obtém ou define o criado em.
createdBy	createdBy	string	Obtém ou define o criado por.
updatedAt	updatedAt	date-time	Obtém ou define a atualização em.
atualizadoPor	updatedBy	string	Obtém ou define a atualização por.
entrevista	interviews	array of Interview	Obtém ou define as entrevistas.

MessageTemplateItem

Essa classe representa um item de modelo de mensagem.

Nome	Caminho	Tipo	Description
id	id	integer	A ID da mensagem de email
nome	name	string	O nome da mensagem de email
conteúdo	content	string	O conteúdo da mensagem de email
assunto	subject	string	O assunto da mensagem de email
defaultLocale	defaultLocale	string	A localidade padrão da mensagem de email
Localidades	locales	array of string	A lista de localidades para esta mensagem de email

MinMaxChoice

Essa classe representa um elemento de escolha máxima mínima dentro de uma pesquisa.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
codificar	code	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
leftText	leftText	array of TranslationElement	Obtém ou define as traduções de texto à esquerda.
rightText	rightText	array of TranslationElement	Obtém ou define as traduções de texto corretas.
excludeFromRandomization	excludeFromRandomization	boolean	Obtém ou define um valor que indica se [excluir da randomização].
condition	condition	ConditionDefinition	Essa classe representa a definição de elementos de condições.

OptOutItem

Essa classe representa um item Opt-Out.

Nome	Caminho	Tipo	Description
email	email	string	Obtém ou define o email.
phone	phone	integer	Obtém ou define o telefone.
optOutAt	optOutAt	string	Obtém ou define o opt-out em.
optOutBy	optOutBy	string	Obtém ou define o opt-out por.

PanelDefinition

Essa classe contém a definição completa de todos os campos contidos em um painel definido pelo cliente.

Nome	Caminho	Tipo	Description
groups	groups	array of VariableGroupElement	Obtém ou define os grupos.
dataAccessControl	dataAccessControl	DataAccessControl	Essa classe contém a configuração de como a entidade está sendo acessível

PanelFieldItem

Essa classe representa um campo de painel dentro de um painel.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
nome de exibição	displayName	string	Obtém ou define o nome de exibição.
isSystem	isSystem	boolean	Obtém ou define um valor que indica se essa instância é do sistema.
obrigatório	mandatory	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.PanelFieldItem é obrigatório.
anonimizar	anonymize	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.PanelFieldItem é anônimo.
validationExpression	validationExpression	string	Obtém ou define a expressão de validação.
validationErrorMessageId	validationErrorMessageId	string	Obtém ou define o identificador de mensagem de validação.
panelFieldType	panelFieldType	VariableType	VariableType
metadados	metadata	object	Obtém ou define os metadados.

PanelIncentive

Essa classe representa um único incentivo.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
priceInCredits	priceInCredits	integer	Obtém ou define o preço em créditos.
descrição	description	string	Obtém ou define a descrição.
availableVouchersCount	availableVouchersCount	integer	Obtém ou define o número de vouchers disponíveis.

PanelSyncBehaviour

: string

PanelSyncElement

Essa classe representa um único item de sincronização entre uma pesquisa e um painel.

Nome	Caminho	Tipo	Description
identificador	identifier	string	Obtém ou define o identificador.
panelField	panelField	string	Obtém ou define o campo do painel.

ReadArtifactListRequest

Essa classe representa os parâmetros de solicitação para a API ReadArtifactList.

Nome	Caminho	Tipo	Description
caminho	path	string	Obtém ou define o caminho.
ID do espaço de trabalho	workspaceId	integer	Obtém ou define o identificador do workspace.

ReadBounceListResponseV3

Essa classe representa os parâmetros de retorno para a API ReadBounceList.

Nome	Caminho	Tipo	Description
Salta	bounces	array of BounceElement	Obtém ou define a lista de saltos.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadCreditBalanceResponse

Essa classe representa os parâmetros de retorno para a API ReadCreditBalance.

Nome	Caminho	Tipo	Description
saldo	balance	integer	Obtém ou define o equilíbrio.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadDistributorListResponse

Essa classe representa os parâmetros de retorno para a API ReadDistributorList.

Nome	Caminho	Tipo	Description
Distribuidores	distributors	array of DistributorElement	Obtém ou define os distribuidores.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadIncentiveListResponse

Essa classe representa os parâmetros de solicitação para a API ReadIncentiveList.

Nome	Caminho	Tipo	Description
panelIncentives	panelIncentives	array of PanelIncentive	Obtém ou define os incentivos do painel.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadIncentiveTransactionListResponse

Essa classe representa os parâmetros de retorno para a API ReadIncentiveTransactionList.

Nome	Caminho	Tipo	Description
incentiveTransactions	incentiveTransactions	array of SurveyCreditLog	Obtém ou define as transações de incentivo.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadInterviewDataResponse

Essa classe representa os parâmetros de retorno para a API ReadInterviewData.

Nome	Caminho	Tipo	Description
responseData	responseData	object	Obtém ou define os dados de resposta.
surveyDefinition	surveyDefinition	SurveyDefinition	Essa classe representa a definição de uma pesquisa que contém todos os metadados e configurações.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadInterviewListCompactResponseV3

Essa classe representa os parâmetros de retorno para a API ReadInterviewListCompact.

Nome	Caminho	Tipo	Description
surveyName	surveyName	string	Obtém ou define o nome da pesquisa.
surveyDefaultLanguage	surveyDefaultLanguage	string	Obtém ou define o idioma padrão da pesquisa.
surveyLanguages	surveyLanguages	array of string	Obtém ou define os idiomas da pesquisa.
entrevista	interviews	array of object	Obtém ou define as entrevistas.
items	interviews	object
codePlan	codePlan	array of SurveyMetadataItem	Obtém ou define o plano de código.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadInterviewListResponseV3

Essa classe representa os parâmetros de retorno para a API ReadInterviewList.

Nome	Caminho	Tipo	Description
surveyName	surveyName	string	Obtém ou define o nome da pesquisa.
surveyDefaultLanguage	surveyDefaultLanguage	string	Obtém ou define o idioma padrão da pesquisa.
surveyLanguages	surveyLanguages	array of string	Obtém ou define os idiomas da pesquisa.
codePlan	codePlan	array of SurveyMetadataItem	Obtém ou define o plano de código.
entrevista	interviews	array of Row	Obtém ou define as entrevistas.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadMemberListResponse

Essa classe representa os parâmetros de retorno para a API ReadMemberList.

Nome	Caminho	Tipo	Description
Membros	members	array of Member	Obtém ou define os membros do painel.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadMessageTemplateListResponse

Essa classe representa os parâmetros de retorno para a API ReadMessageTemplateList.

Nome	Caminho	Tipo	Description
messageTemplates	messageTemplates	array of MessageTemplateItem	Obtém ou define os modelos de mensagem.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadOptOutListResponseV3

Essa classe representa os parâmetros de retorno para a API ReadOptOutList.

Nome	Caminho	Tipo	Description
optOutItems	optOutItems	array of OptOutItem	Obtém ou define os itens de recusa.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadPanelDefinitionResponse

Essa classe representa os parâmetros de retorno para a API ReadPanelDefinition.

Nome	Caminho	Tipo	Description
painel	panel	PanelDefinition	Essa classe contém a definição completa de todos os campos contidos em um painel definido pelo cliente.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadSamplingProjectResponse

Essa classe representa os parâmetros de retorno para a API ReadSamplingProject.

Nome	Caminho	Tipo	Description
samplingProject	samplingProject	SamplingProjectElement	Essa classe representa um projeto de amostragem.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadSurveyLinksResponse

Essa classe representa a resposta da API ReadSurveyLinks.

Nome	Caminho	Tipo	Description
anonymousList	anonymousList	array of SurveyLink	Obtém ou define a lista anônima.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadSurveyListResponse

Essa classe representa os parâmetros de resposta para a API ReadSurveyList.

Nome	Caminho	Tipo	Description
Pesquisas	surveys	array of SurveyListItem	Obtém ou define as pesquisas.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadSurveyResponse

Essa classe representa os parâmetros de retorno para a API ReadSurveyDefinition.

Nome	Caminho	Tipo	Description
surveyName	surveyName	string	Obtém ou define o nome da pesquisa.
surveyVersion	surveyVersion	integer	Obtém ou define a versão da pesquisa.
surveyState	surveyState	string	Obtém ou define o estado da pesquisa.
createdAt	createdAt	string	Obtém ou define o criado em.
createdBy	createdBy	string	Obtém ou define o criado por.
pesquisa	survey	SurveyDefinition	Essa classe representa a definição de uma pesquisa que contém todos os metadados e configurações.
surveyConfiguration	surveyConfiguration	SurveyConfiguration	Essa classe representa a configuração da pesquisa com todas as configurações que um usuário pode configurar.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadWebHookListResponse

Essa classe representa os parâmetros de retorno para a API ReadWebHookList.

Nome	Caminho	Tipo	Description
WebHooks	webHooks	array of WebHookElement	Obtém ou define os ganchos da Web.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadWorkflowTransitionsResponse

Essa classe representa os parâmetros de retorno para a API ReadWorkflowTransitions.

Nome	Caminho	Tipo	Description
Transições	transitions	array of WorkflowTransition	Obtém ou define as transições.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadWorkspaceListResponse

Essa classe representa os parâmetros de solicitação para a API ReadWorkspaceList.

Nome	Caminho	Tipo	Description
workspaces	workspaces	array of WorkspaceDto	Obtém ou define os workspaces.
totalCount	totalCount	integer	Obtém ou define a contagem total.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

RedeemIncentiveCodeResponse

Essa classe representa os parâmetros de retorno para a API RedeemIncentiveCode.

Nome	Caminho	Tipo	Description
voucherCode	voucherCode	string	Obtém ou define o código do voucher.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

RemindMembersResponse

Essa classe representa os parâmetros de retorno para a API RemindMembers.

Nome	Caminho	Tipo	Description
reminderId	reminderId	integer	Obtém ou define o identificador de lembrete.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ResetInterviewResponse

Essa classe representa os parâmetros de retorno para a API ResetInterview.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

Row

Essa classe representa um item de linha.

Nome	Caminho	Tipo	Description
columns	columns	array of ColItem	Obtém ou define as colunas.

RowItem

Essa classe representa uma resposta de pesquisa.

Nome	Caminho	Tipo	Description
id	id	string	Obtém ou define o identificador.
value	value	string	Obtém ou define o valor.

SamplingProjectElement

Essa classe representa um projeto de amostragem.

Nome	Caminho	Tipo	Description
samplingProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
nome	name	string	Obtém ou define o nome.
ID do espaço de trabalho	workspaceId	integer	Obtém ou define o identificador do workspace.
surveyId	surveyId	integer	Obtém ou define o identificador da pesquisa.
surveyVersion	surveyVersion	integer	Obtém ou define a versão da pesquisa.
panelId	panelId	integer	Obtém ou define o identificador do painel.
samplingProviderId	samplingProviderId	integer	Obtém ou define o identificador do provedor de amostragem.
projectState	projectState	string	Obtém ou define o estado do projeto.
scheduledDistribution	scheduledDistribution	string	Obtém ou define a distribuição agendada.
executedDistribution	executedDistribution	string	Obtém ou define a distribuição executada.
conditions	conditions	array of ConditionDefinition	Obtém ou define as condições.

ScriptType

: string

Seção

Essa classe representa uma seção dentro de uma pesquisa.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
randomizePages	randomizePages	boolean	Obtém ou define um valor que indica se [randomizar páginas].
excludeFromRandomization	excludeFromRandomization	boolean	Obtém ou define um valor que indica se [excluir da randomização].
Elementos	elements	array of SurveyElement	Obtém ou define os elementos.
condition	condition	ConditionDefinition	Essa classe representa a definição de elementos de condições.

SurveyConfiguration

Essa classe representa a configuração da pesquisa com todas as configurações que um usuário pode configurar.

Nome	Caminho	Tipo	Description
designConfiguration	designConfiguration	DesignConfiguration	Essa classe representa as possibilidades de estilo de uma conta.
anonymizingConfiguration	anonymizingConfiguration	AnonymizingConfiguration	Essa classe contém as configurações de anonimização que podem ser aplicadas a um grupo de workspaces, a um workspace ou a uma pesquisa individual.

SurveyCreditLog

Essa classe representa uma única transação de crédito.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
oldValue	oldValue	string	Obtém ou define o valor antigo.
newValue	newValue	string	Obtém ou define o novo valor.
descrição	description	string	Obtém ou define a descrição.
modifiedDate	modifiedDate	string	Obtém ou define a data modificada.
modifiedBy	modifiedBy	string	Obtém ou define o modificado por.
responseId	responseId	uuid	Obtém ou define o identificador de resposta.
interviewLink	interviewLink	string	Obtém ou define o link da entrevista.

SurveyDefinition

Essa classe representa a definição de uma pesquisa que contém todos os metadados e configurações.

Nome	Caminho	Tipo	Description
allowMultipleParticipation	allowMultipleParticipation	boolean	Obtém ou define um valor que indica se [permitir várias participações].
allowNavigateBack	allowNavigateBack	boolean	Obtém ou define um valor que indica se [permitir navegar de volta].
allowSaveProgress	allowSaveProgress	boolean	Obtém ou define um valor que indica se [permitir o progresso de salvamento].
randomizeSections	randomizeSections	boolean	Obtém ou define um valor que indica se [randomizar seções].
enableAutoScroll	enableAutoScroll	boolean	Obtém ou define um valor que indica se [habilitar rolagem automática].
enableCodeAccess	enableCodeAccess	boolean	Obtém ou define um valor que indica se [habilitar o acesso ao código].
dataAccessControl	dataAccessControl	DataAccessControl	Essa classe contém a configuração de como a entidade está sendo acessível
associatedPanels	associatedPanels	array of integer	Obtém ou define o identificador do painel.
codeAccessMode	codeAccessMode	CodeAccessMode	AuthenticationType
enablePanelSync	enablePanelSync	boolean	Obtém ou define um valor que indica se [habilitar sincronização de painel].
panelSyncBehaviour	panelSyncBehaviour	PanelSyncBehaviour	PanelSyncBehaviour
panelSyncs	panelSyncs	array of PanelSyncElement	Obtém ou define as sincronizações do painel.
defaultLanguage	defaultLanguage	string	Obtém ou define o idioma padrão.
data de término	endDate	date-time	Obtém ou define a data de término.
Idiomas	languages	array of string	Obtém ou define os idiomas.
Seções	sections	array of Section	Obtém ou define as seções.
customVariables	customVariables	array of CustomVariable	Obtém ou define as variáveis personalizadas.
surveyEndText	surveyEndText	array of TranslationElement	Obtém ou define o texto final da pesquisa.
defaultTextOverrides	defaultTextOverrides	object	Obtém ou define as substituições de texto padrão.

SurveyElement

Essa classe representa uma definição de elemento de pesquisa com todos os metadados e configurações.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
elementType	elementType	ElementType	ElementType
codificar	code	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtém ou define um valor que indica se [o código foi alterado manualmente].
enviar SMS	text	array of TranslationElement	Obtém ou define as traduções de texto.
hintText	hintText	array of TranslationElement	Obtém ou define as traduções de texto de dica.
hasHintText	hasHintText	boolean	Obtém ou define um valor que indica se essa instância tem texto de dica.
hasNotAvailableChoice	hasNotAvailableChoice	boolean	Obtém ou define um valor que indica se essa instância não tem escolha disponível.
notAvailableChoiceText	notAvailableChoiceText	array of TranslationElement	Obtém ou define as traduções de texto de opção não disponíveis.
forceResponse	forceResponse	boolean	Obtém ou define um valor que indica se [forçar resposta].
choices	choices	array of Choice	Obtém ou define as opções.
randomizeChoices	randomizeChoices	boolean	Obtém ou define um valor que indica se [escolhas aleatórias].
columnType	columnType	ColumnType	TipoDeColuna
solicitação	prompt	array of TranslationElement	Obtém ou define o prompt.
valor mínimo	minValue	integer	Obtém ou define o valor mínimo.
valorMáximo	maxValue	integer	Obtém ou define o valor máximo.
showCenterLabel	showCenterLabel	boolean	Obtém ou define um valor que indica se [mostrar rótulo central].
leftLabel	leftLabel	array of TranslationElement	Obtém ou define o rótulo esquerdo.
centerLabel	centerLabel	array of TranslationElement	Obtém ou define o rótulo central.
rightLabel	rightLabel	array of TranslationElement	Obtém ou define o rótulo certo.
showValue	showValue	boolean	Obtém ou define um valor que indica se [mostrar valor].
maxDecimals	maxDecimals	integer	Obtém ou define os dígitos máximos após a vírgula.
textFieldSize	textFieldSize	TextFieldSize	TextFieldSize
preenchimento automático	autocomplete	boolean	Obtém ou define um valor que indica se esse Survalyzer.Contracts.Public.Elements.SurveyElement é preenchimento automático.
autocompleteText	autocompleteText	array of TranslationElement	Obtém ou define as traduções de texto de preenchimento automático.
contentValidation	contentValidation	ContentValidation	Essa classe representa uma validação de conteúdo dentro de uma pesquisa.
hasPlaceholder	hasPlaceholder	boolean	Obtém ou define um valor que indica se essa instância tem espaço reservado.
espaço reservado	placeholder	array of TranslationElement	Obtém ou define o espaço reservado.
isPassword	isPassword	boolean	Obtém ou define um valor que indica se essa instância é senha.
minMaxValidation	minMaxValidation	boolean	Obtém ou define um valor que indica se [validação máxima mínima].
minimumCheckedChoices	minimumCheckedChoices	integer	Obtém ou define as opções mínimas marcadas.
maximumCheckedChoices	maximumCheckedChoices	integer	Obtém ou define o máximo de opções verificadas.
columnGroups	columnGroups	array of ColumnGroup	Obtém ou define os grupos de colunas.
randomizeRows	randomizeRows	boolean	Obtém ou define um valor que indica se [randomizar linhas].
Linhas	rows	array of MinMaxChoice	Obtém ou define as linhas.
numberOfRanks	numberOfRanks	integer	Obtém ou define o número de classificações.
likeText	likeText	array of TranslationElement	Obtém ou define as traduções de texto semelhantes.
dislikeText	dislikeText	array of TranslationElement	Obtém ou define as traduções de texto de antipatia.
hasStartText	hasStartText	boolean	Obtém ou define um valor que indica se essa instância tem texto inicial.
startText	startText	array of TranslationElement	Obtém ou define o texto inicial.
enableMeasurement	enableMeasurement	boolean	Obtém ou define um valor que indica se [habilitar medida].
showButtons	showButtons	boolean	Obtém ou define um valor que indica se [mostrar botões].
likeKey	likeKey	string	Obtém ou define a tecla like.
dislikeKey	dislikeKey	string	Obtém ou define a chave de antipatia.
interviewState	interviewState	string	Obtém ou define o estado da resposta.
ação	action	ActionElement	Essa classe representa um fim da ação de pesquisa para completo/screenout/cota completa.
from	from	string	Obtém ou define o remetente.
para	to	string	Obtém ou define o receptor.
assunto	subject	array of TranslationElement	Obtém ou define as traduções de assunto.
mensagem	message	array of TranslationElement	Obtém ou define as traduções de mensagem.
valueAssignmentType	valueAssignmentType	ValueAssignmentType	ValueAssignmentType
variableName	variableName	string	Obtém ou define o nome da variável.
functionTerm	functionTerm	array of TranslationElement	Obtém ou define o termo da função.
executionBehavior	executionBehavior	ExecutionBehavior	ExecutionBehavior
apiCallMethod	apiCallMethod	ApiCallMethod	ApiCallMethod
url	url	array of TranslationElement	Obtém ou define a URL.
headers	headers	string	Obtém ou define os cabeçalhos.
body	body	array of TranslationElement	Obtém ou define o corpo.
externalUri	externalUri	string	Obtém ou define o URI externo.
scriptType	scriptType	ScriptType	ScriptType
conteúdo	content	string	Obtém ou define o conteúdo.
hasRatingLabels	hasRatingLabels	boolean	Obtém ou define um valor que indica se essa instância tem rótulos de classificação.
leftRatingLabel	leftRatingLabel	array of TranslationElement	Obtém ou define o rótulo de classificação à esquerda.
rightRatingLabel	rightRatingLabel	array of TranslationElement	Obtém ou define o rótulo de classificação correto.
condition	condition	ConditionDefinition	Essa classe representa a definição de elementos de condições.
evaluateAsJson	evaluateAsJson	boolean	Obtém ou define um valor que indica se [avaliar como json].
autocompleteListVariable	autocompleteListVariable	string	Obtém ou define a variável de lista de preenchimento automático.
arrangementMode	arrangementMode	ArrangementMode	ArrangementMode
enableAnimation	enableAnimation	boolean	Obtém ou define um valor que indica se [habilitar animação].
useSmiley	useSmiley	boolean	Obtém ou define um valor que indica se [use smiley].
hasPrompt	hasPrompt	boolean	Obtém ou define um valor que indica se essa instância tem prompt.

SurveyLink

A entidade SurveyLink

Nome	Caminho	Tipo	Description
url	url	string	Obtém ou define a URL.
isCustom	isCustom	boolean	Obtém ou define um valor que indica se essa instância é personalizada.
linguagem	language	string	Obtém ou define o idioma.

SurveyListItem

Essa classe representa um único item de pesquisa.

Nome	Caminho	Tipo	Description
id	id	integer	A ID da pesquisa
nome	name	string	O nome da pesquisa
modifiedDate	modifiedDate	string	A data modificada da pesquisa
data de término	endDate	string	A data em que a pesquisa termina
isEndDateEnabled	isEndDateEnabled	boolean	Se a data de término estiver habilitada para esta pesquisa
status	status	SurveyStatus	SurveyStatus
archiveDate	archiveDate	string	A data em que a pesquisa foi arquivada
statusOn	statusOn	boolean	A pesquisa está ativada ou desativada
respostas	answers	integer	Obtém ou define as respostas.

SurveyMetadataItem

Essa classe representa um único item de metadados.

Nome	Caminho	Tipo	Description
codificar	code	string	Obtém ou define o código.
Datatype	dataType	string	Obtém ou define o tipo de dados.
questionCode	questionCode	string	Obtém ou define o código de pergunta.
tipo	type	string	Obtém ou define o tipo.
pergunta	question	string	Obtém ou define a questão.
linha	row	string	Obtém ou define a linha.
opção	choice	string	Obtém ou define a opção.
values	values	array of RowItem	Obtém ou define os valores.
sectionName	sectionName	string	Obtém ou define o nome da seção.

SurveyStatus

: string

TextBlock

Nome	Caminho	Tipo	Description
nome	name	string	Obtém ou define o nome.
tipo	type	string	Obtém ou define o tipo.
enviar SMS	text	array of TranslationElement	Obtém ou define o texto.

TextFieldSize

: string

TranslationElement

Essa classe representa uma tradução de texto dentro de uma pesquisa.

Nome	Caminho	Tipo	Description
languageCode	languageCode	string	Obtém ou define o código do idioma.
enviar SMS	text	string	Obtém ou define o texto.

UpdateMembersResponse

Essa classe representa os parâmetros de retorno para a API UpdateMembers.

Nome	Caminho	Tipo	Description
validationIssues	validationIssues	array of WritePanelMemberIssue	Obtém ou define os problemas.
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

UpdateSurveyResponse

Essa classe representa os parâmetros de retorno para a API UpdateSurvey.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

UpdateWebHookResponse

Essa classe representa os parâmetros de retorno para a API CreateWebHook.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ValueAssignmentType

: string

VariableGroupElement

Essa classe representa um grupo de campos em um painel.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
nome de exibição	displayName	string	Obtém ou define o nome de exibição.
fields	fields	array of PanelFieldItem	Obtém ou define os campos.

VariableType

: string

WebHookElement

Essa classe representa um único WebHook

Nome	Caminho	Tipo	Description
id	id	uuid	Obtém ou define o identificador.
eventType	eventType	EventType	Tipo de Evento
entityIdentifier	entityIdentifier	string	Obtém ou define o identificador de entidade.
createdAt	createdAt	date-time	Obtém ou define o criado em.
createdBy	createdBy	string	Obtém ou define o criado por.
updatedAt	updatedAt	date-time	Obtém ou define a atualização em.
atualizadoPor	updatedBy	string	Obtém ou define a atualização por.

WorkflowTransition

Essa classe representa uma transição de um estado para outro.

Nome	Caminho	Tipo	Description
nome	name	string	Obtém ou define o nome.
ação	action	string	Obtém ou define o nome da ação.
newState	newState	string	Cria um novo estado.
condition	condition	string	Obtém ou define a condição.

WorkspaceDto

Essa classe representa uma entidade de workspace.

Nome	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
numberOfSurveys	numberOfSurveys	integer	Obtém ou define o número de pesquisas.

WriteOptOutListResponse

Essa classe representa os parâmetros de retorno para a API WriteOptOutList.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

WritePanelMemberIssue

Representar algum problema que pode ser exibido

Nome	Caminho	Tipo	Description
código de erro	errorCode	string	Obtém ou define o código de erro.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.

WritePanelResponse

Essa classe representa os parâmetros de retorno para a API WritePanel.

Nome	Caminho	Tipo	Description
isSuccess	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

Compartilhar via

Survalyzer UE (versão prévia)

Criando uma conexão

Padrão

Limitações

Ações

Atualizar membros

Parâmetros

Retornos

Atualizar o Web Hook

Parâmetros

Retornos

Atualizar Opt-Outs

Parâmetros

Retornos

Atualizar Pesquisa

Parâmetros

Retornos

Baixar PDF de entrevista

Parâmetros

Retornos

Convidar Membros

Parâmetros

Retornos

Convidar Membros

Parâmetros

Retornos

Criar Artefato

Parâmetros

Retornos

Criar Membros

Parâmetros

Retornos

Criar painel ou exemplo

Parâmetros

Retornos

Criar Pesquisa

Parâmetros

Retornos

Criar WebHook

Parâmetros

Retornos

Código de incentivo de resgate

Parâmetros

Retornos

Enviar Email

Parâmetros

Retornos

Excluir Artefato

Parâmetros

Retornos

Excluir Distribuidor

Parâmetros

Retornos

Excluir Entrevista

Parâmetros

Retornos

Excluir Membros

Parâmetros

Retornos

Excluir Painel

Parâmetros

Retornos

Excluir Pesquisa

Parâmetros

Retornos

Excluir projeto de amostragem

Parâmetros

Retornos

Excluir WebHook

Parâmetros

Retornos

Executar transição de fluxo de trabalho

Parâmetros

Retornos

Lembrar Membros

Parâmetros

Retornos

Ler artefatos

Parâmetros