Survalyzer Eu (предварительная версия)
Survalyzer Eu помогает командам автоматизировать отзывы и исследовательские рабочие процессы в опросах, панелях, образцах, дистрибутивах, интервью, веб-перехватчиках, стимулах и рабочих областях. Он подключает данные и операции Survalyzer к рабочим процессам бизнеса, чтобы организации могли эффективно управлять участниками, отправлять сообщения и обрабатывать данные ответа.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Центр разработчиков Survalyzer |
| URL | https://developer.survalyzer.com/ |
| Метаданные соединителя | |
|---|---|
| Publisher | Survalyzer AG |
| Веб-сайт | https://survalyzer.com |
| Политика конфиденциальности | https://survalyzer.com/privacy-policy |
| Категории | Маркетинг; Продуктивность |
Сурвализер Ес
Survalyzer Eu помогает командам автоматизировать отзывы и исследовательские рабочие процессы в опросах, панелях, образцах, дистрибутивах, интервью, веб-перехватчиках, стимулах и рабочих областях. Он подключает данные и операции Survalyzer к рабочим процессам бизнеса, чтобы организации могли эффективно управлять участниками, отправлять сообщения и обрабатывать данные ответа.
Publisher: Survalyzer AG
Необходимые условия
- Активная подписка Survalyzer с доступом к центру обработки данных Eu. Чтобы получить подписку, обратитесь sales@survalyzer.com к ним.
- Учетная запись Survalyzer с разрешениями на доступ к параметрам службы автоматизации, необходимая для получения учетных данных OAuth.
Поддерживаемые операции
Common
| Operation | Description |
|---|---|
| Создание артефакта | Создайте новый артефакт, связанный с опросом или панелью. |
| Удаление артефакта | Удаление существующего артефакта. |
| Чтение артефактов | Получение списка артефактов для рабочей области. |
Survey
| Operation | Description |
|---|---|
| Создание опроса | Создайте опрос в указанной рабочей области. |
| Удаление опроса | Удаление существующего опроса. |
| Чтение опроса | Прочитайте определение определенного опроса. |
| Чтение опросов | Прочитайте все доступные опросы определенной рабочей области. |
| Обновление опроса | Обновите существующее определение опроса. |
Панель и пример
| Operation | Description |
|---|---|
| Создание панели или примера | Создайте новую панель или проект выборки. |
| Удаление панели | Удаление существующей панели. |
| Панель чтения | Прочитайте определение существующей панели. |
| Панель обновления | Обновите существующее определение панели. |
| Delete Выборка Project | Удалите существующий проект выборки. |
| Читаемая выборка Project | Прочитайте определение существующего проекта выборки. |
Members
| Operation | Description |
|---|---|
| Создание участников | Создайте список элементов для панели. |
| Удаление элементов | Удаление элементов из панели. |
| Чтение членов | Чтение элементов панели. |
| Обновление элементов | Обновите существующие элементы на панели. |
| Приглашение участников | Создание и приглашение участников на панель. |
| Напоминать членам | Отправьте напоминание членам панели. |
| Сброс интервью | Сброс ответа члена панели. |
Distribution
| Operation | Description |
|---|---|
| Чтение распространителей | Ознакомьтесь со списком распространителей. |
| Удаление распространителя | Удаление существующего распространителя. |
| Выполнение перехода рабочего процесса | Выполнение определенного перехода рабочего процесса. |
| Чтение переходов рабочих процессов | Чтение всех переходов рабочих процессов для рабочего процесса. |
| Чтение шаблонов сообщений | Извлеките все настроенные шаблоны сообщений электронной почты и SMS. |
| Отправить электронное письмо | Отправьте сообщение электронной почты с помощью настроенного шаблона сообщения. |
| Чтение отказов | Прочитайте список отказов для рабочей области. |
| Чтение отказов | Чтение всех отказов для рабочей области. |
| Обновление отказов | Запись записей в список отказов для рабочей области. |
| Чтение ссылок опроса | Ознакомьтесь со ссылками опроса для распространения. |
Собеседование
| Operation | Description |
|---|---|
| Чтение интервью | Ознакомьтесь с данными для определенного интервью. |
| Чтение интервью | Ознакомьтесь с полным списком интервью. |
| Чтение интервью Compact | Ознакомьтесь с компактной версией списка интервью. |
| Удаление интервью | Удаление существующей записи интервью. |
| Скачивание PDF-файла интервью | Скачайте ответы на интервью в формате PDF. |
Webhook
| Operation | Description |
|---|---|
| Создание веб-перехватчика | Создайте новый веб-перехватчик для уведомлений на основе событий. |
| Удаление веб-перехватчика | Удаление существующего веб-перехватчика. |
| Чтение веб-перехватчиков | Ознакомьтесь со списком настроенных веб-перехватчиков. |
| Обновление веб-перехватчика | Обновите существующую конфигурацию веб-перехватчика. |
Стимул
| Operation | Description |
|---|---|
| Чтение кредитного баланса | Возвращает кредитный баланс опроса для прошедшего проверку подлинности пользователя. |
| Стимулы для чтения | Возвращает все доступные стимулы или ваучеры для прошедшего проверку подлинности пользователя. |
| Чтение транзакций поощрения | Возвращает общие сведения о доходах и расходах, связанных с кредитами опроса. |
| Активация кода стимула | Проводите опросные кредиты для активации стимула или ваучера. |
Workspace
| Operation | Description |
|---|---|
| Чтение рабочих областей | Чтение всех доступных рабочих областей для учетной записи, прошедшей проверку подлинности. |
Получение учетных данных
Этот соединитель использует OAuth 2.0 для проверки подлинности. Чтобы получить учетные данные, выполните приведенные далее действия.
- Войдите в учетную запись Survalyzer.https://login.survalyzer.com
- Перейдите к параметрам учетной записи.
- Перейдите на вкладку "Автоматизация ".
- Скопируйте идентификатор клиента и секрет клиента , отображаемые на этом экране.
Эти учетные данные используются для проверки подлинности соединителя с помощью потока OAuth 2.0.https://authentication.survalyzer-eu.app
Примечание: Это подключение недоступно для общего доступа. Если приложение, использующее этот соединитель, предоставляется другому пользователю, пользователю будет предложено создать собственное подключение с помощью собственных учетных данных.
Getting Started
- Найдите соединитель Survalyzer Eu .
- Нажмите кнопку "Добавить подключение " и введите идентификатор клиента и секрет клиента на вкладке "Автоматизация" параметров учетной записи Survalyzer.
- Проверка подлинности с помощью потока OAuth 2.0.
- Начните создавать рабочие процессы с помощью поддерживаемых операций, перечисленных выше.
Сведения о документации по API и ресурсах разработчиков см. в Центре разработчиков Survalyzer.
Известные проблемы и ограничения
- Этот соединитель предназначен для центра обработки данных Ес (
api.survalyzer-eu.app). Если ваша учетная запись Survalyzer размещена в швейцарском центре обработки данных, используйте вместо этого соединитель Survalyzer Swiss. - Все операции используют HTTP POST.
- В настоящее время не поддерживаются операции триггеров на основе GET. Используйте веб-перехватчики для рабочих процессов на основе событий.
- Обновление маркера OAuth обрабатывается автоматически.
Журнал изменений
v3.0
- Исправлено обновление маркера OAuth, чтобы убедиться, что маркеры обновляются автоматически.
- Добавлен полный набор операций API версии 3 во всех категориях служб.
v2.x
- Первоначальный выпуск сертифицированного соединителя.
- Рассматриваются основные операции опроса, панели и распределения.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Активация кода стимула |
Это действие предлагает возможность тратить кредиты на опросы для стимулов и ваучеров. |
| Выполнение перехода рабочего процесса |
Это действие обеспечивает возможность выполнения перехода рабочих процессов, характерных для рабочего процесса. |
| Напоминать членам |
Это действие предлагает возможность напомнить участнику. |
| Обновление Opt-Outs |
Это действие позволяет записывать записи в список Opt-Out для рабочей области. |
| Обновление веб-перехватчика |
Это действие предлагает возможность обновить веб-перехватчик. |
| Обновление опроса |
Это действие предоставляет возможность обновить опрос. |
| Обновление элементов |
Это действие позволяет обновить список участников. |
| Отправить сообщение электронной почты |
Это действие обеспечивает возможность отправки почты. |
| Панель обновления |
Это действие позволяет обновить панель. |
| Панель чтения |
Это действие обеспечивает возможность чтения определения панели. |
| Приглашение участников |
Это действие предлагает возможность пригласить участника. |
| Приглашение участников |
Это действие предоставляет возможность создавать и приглашать участников. |
| Сброс интервью |
Это действие обеспечивает возможность сброса ответа члена панели. |
| Скачивание PDF-файла интервью |
Это действие позволяет скачать ответы. |
| Создание артефакта |
Это действие предоставляет возможность создания нового артефакта. |
| Создание веб-перехватчика |
Это действие позволяет создать веб-перехватчик. |
| Создание опроса |
Это действие обеспечивает возможность создания опроса. |
| Создание панели или примера |
Это действие позволяет создать новую панель. |
| Создание участников |
Это действие позволяет создать список участников. |
| Стимулы для чтения |
Это действие возвращает доступные стимулы и ваучеры для прошедшего проверку подлинности пользователя. |
| Удаление артефакта |
Это действие обеспечивает возможность удаления артефакта. |
| Удаление веб-перехватчика |
Это действие обеспечивает возможность удаления веб-перехватчика. |
| Удаление интервью |
Это действие позволяет удалить интервью. |
| Удаление опроса |
Это действие обеспечивает возможность удаления опроса. |
| Удаление панели |
Это действие обеспечивает возможность удаления панели. |
| Удаление проекта выборки |
Это действие позволяет удалить проект выборки. |
| Удаление распространителя |
Это действие обеспечивает возможность удаления распространителя. |
| Удаление элементов |
Это действие обеспечивает возможность удаления участников. |
| Чтение Opt-Outs |
Это действие обеспечивает возможность чтения всех Opt-Outs рабочей области. |
| Чтение артефактов |
Это действие предлагает возможность прочитать список артефактов. |
| Чтение веб-перехватчиков |
Это действие позволяет считывать список веб-перехватчиков. |
| Чтение интервью |
Это действие предлагает возможность прочитать данные интервью. |
| Чтение интервью |
Это действие предлагает возможность прочитать список интервью. |
| Чтение интервью Compact |
Это действие предлагает возможность прочитать список интервью компактным. |
| Чтение кредитного баланса |
Это действие возвращает кредитный баланс опроса для прошедшего проверку подлинности пользователя. |
| Чтение опроса |
Это действие предоставляет возможность прочитать опрос. |
| Чтение опросов |
Это действие предоставляет возможность прочитать все доступные опросы данной рабочей области. |
| Чтение отказов |
Это действие предлагает возможность прочитать список отказов. |
| Чтение переходов рабочих процессов |
Это действие обеспечивает возможность считывания всех переходов рабочих процессов, относящихся к рабочему процессу. |
| Чтение проекта выборки |
Это действие позволяет прочитать проект выборки. |
| Чтение рабочих областей |
Это действие обеспечивает возможность чтения всех доступных рабочих областей. |
| Чтение распространителей |
Это действие позволяет прочитать список распространителя. |
| Чтение ссылок опроса |
Это действие предоставляет возможность считывать ссылки на опрос. |
| Чтение транзакций поощрения |
Это действие возвращает обзор всех доходов и расходов, связанных с кредитами опроса. |
| Чтение членов |
Это действие обеспечивает возможность чтения членов. |
| Чтение шаблонов сообщений |
Это действие позволяет получать все настроенные шаблоны сообщений для электронной почты и SMS. |
Активация кода стимула
Это действие предлагает возможность тратить кредиты на опросы для стимулов и ваучеров.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
incentiveId
|
incentiveId | True | integer |
Возвращает или задает идентификатор стимула. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API RedeemIncentiveCode.
Выполнение перехода рабочего процесса
Это действие обеспечивает возможность выполнения перехода рабочих процессов, характерных для рабочего процесса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
workflow
|
workflow | True | string |
Тип рабочего процесса |
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
|
|
reminderId
|
reminderId | integer |
Возвращает или задает идентификатор напоминания. |
|
|
targetState
|
targetState | True | string |
Возвращает или задает состояние целевого объекта. |
|
DynamicParameters
|
dynamicParameters | object |
Возвращает или задает динамические параметры. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ExecuteWorkflowTransition.
Напоминать членам
Это действие предлагает возможность напомнить участнику.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификаторДистрибьютора
|
distributorId | True | integer |
Идентификатор опроса |
|
messageTemplateId
|
messageTemplateId | True | integer |
Возвращает или задает идентификатор шаблона сообщения. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
|
type
|
type | string |
Возвращает или задает тип. |
|
|
languageCode
|
languageCode | True | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
|
|
scheduleDateTime
|
scheduleDateTime | date-time |
Возвращает или задает время расписания. |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
канал
|
channel | string |
Канал распространения |
|
|
от / из / с (context-dependent)
|
from | string |
Возвращает или задает из. |
|
|
fromName
|
fromName | string |
Возвращает или задает из имени. |
|
|
replyTo
|
replyTo | string |
Возвращает или задает ответ. |
|
|
replyToName
|
replyToName | string |
Возвращает или задает имя ответа. |
Возвращаемое значение
Этот класс представляет параметры возврата для API RemindMembers.
Обновление Opt-Outs
Это действие позволяет записывать записи в список Opt-Out для рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
workspaceId
|
workspaceId | integer |
Возвращает или задает идентификатор рабочей области. |
|
|
panelId
|
panelId | integer |
Возвращает или задает идентификатор панели. |
|
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
|
|
электронная почта
|
True | string |
Возвращает или задает сообщение электронной почты. |
|
|
optOutOperation
|
optOutOperation | True | string |
OptOutOperation |
|
мобильный телефон
|
cellPhone | True | integer |
Получает или задает мобильный телефон. |
|
optOutOperation
|
optOutOperation | True | string |
OptOutOperation |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API WriteOptOutList.
Обновление веб-перехватчика
Это действие предлагает возможность обновить веб-перехватчик.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
webHookId
|
webHookId | uuid |
Возвращает или задает идентификатор веб-перехватчика. |
|
|
eventType
|
eventType | string |
Тип события |
|
|
entityIdentifier
|
entityIdentifier | string |
Возвращает или задает идентификатор сущности. |
|
|
securityToken
|
securityToken | string |
Возвращает или задает маркер безопасности. |
|
|
webHookUrl
|
webHookUrl | string |
Возвращает или задает URL-адрес веб-перехватчика. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API CreateWebHook.
Обновление опроса
Это действие предоставляет возможность обновить опрос.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
surveyId
|
surveyId | True | integer |
Возвращает или задает идентификатор опроса. |
|
surveyName
|
surveyName | string |
Возвращает или задает имя опроса. |
|
|
allowMultipleParticipation
|
allowMultipleParticipation | True | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить несколько участников]. |
|
allowNavigateBack
|
allowNavigateBack | True | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить возврат]. |
|
allowSaveProgress
|
allowSaveProgress | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить ход сохранения]. |
|
|
randomizeSections
|
randomizeSections | True | boolean |
Возвращает или задает значение, указывающее, [случайные разделы]. |
|
enableAutoScroll
|
enableAutoScroll | boolean |
Возвращает или задает значение, указывающее, включена ли [включить автоматическую прокрутку]. |
|
|
enableCodeAccess
|
enableCodeAccess | boolean |
Возвращает или задает значение, указывающее, включен ли [включить доступ к коду]. |
|
|
accessType
|
accessType | string |
ТипДоступа |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
associatedPanels
|
associatedPanels | array of integer |
Возвращает или задает идентификатор панели. |
|
|
codeAccessMode
|
codeAccessMode | True | string |
AuthenticationType |
|
enablePanelSync
|
enablePanelSync | boolean |
Возвращает или задает значение, указывающее, включена ли [синхронизация панели]. |
|
|
panelSyncBehaviour
|
panelSyncBehaviour | string |
PanelSyncBehaviour |
|
|
идентификатор
|
identifier | string |
Возвращает или задает идентификатор. |
|
|
panelField
|
panelField | string |
Возвращает или задает поле панели. |
|
|
Язык defaultLanguage
|
defaultLanguage | True | string |
Возвращает или задает язык по умолчанию. |
|
Дата окончания
|
endDate | date-time |
Возвращает или задает дату окончания. |
|
|
Языки
|
languages | True | array of string |
Возвращает или задает языки. |
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
имя
|
name | True | string |
Возвращает или задает имя. |
|
randomizePages
|
randomizePages | True | boolean |
Возвращает или задает значение, указывающее, [случайные страницы]. |
|
excludeFromRandomization
|
excludeFromRandomization | True | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
elementType
|
elementType | True | string |
ElementType |
|
код
|
code | string |
Возвращает или задает код. |
|
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
|
languageCode
|
languageCode | True | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
|
|
hasHintText
|
hasHintText | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр текст подсказки. |
|
|
hasNotAvailableChoice
|
hasNotAvailableChoice | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр недоступный выбор. |
|
|
forceResponse
|
forceResponse | boolean |
Возвращает или задает значение, указывающее, является ли [принудительный ответ]. |
|
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
код
|
code | True | string |
Возвращает или задает код. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
|
allowTextEntry
|
allowTextEntry | True | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить запись текста]. |
|
forceInput
|
forceInput | True | boolean |
Возвращает или задает значение, указывающее, является ли [принудительное ввод]. |
|
автозавершение
|
autocomplete | True | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.Choice автозавершением. |
|
исключительный
|
exclusive | True | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.Choice эксклюзивным. |
|
excludeFromRandomization
|
excludeFromRandomization | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
|
validationType
|
validationType | True | string |
Проверка содержимого |
|
ранняяDate
|
earliestDate | string |
Возвращает или задает раннюю дату. |
|
|
latestDate
|
latestDate | string |
Возвращает или задает последнюю дату. |
|
|
минимальное значение
|
minValue | double |
Возвращает или задает минимальное значение. |
|
|
максимальное значение
|
maxValue | double |
Возвращает или задает максимальное значение. |
|
|
decimalPlaces
|
decimalPlaces | integer |
Возвращает или задает десятичные разряды. |
|
|
disableThousandSeparator
|
disableThousandSeparator | boolean |
Возвращает или задает разделитель отключаемой тысячи. |
|
|
conditionAction
|
conditionAction | True | string |
FilterAction |
|
autocompleteListVariable
|
autocompleteListVariable | string |
Возвращает или задает переменную списка автозаполнения. |
|
|
randomizeChoices
|
randomizeChoices | boolean |
Возвращает или задает значение, указывающее, является ли [случайный выбор]. |
|
|
columnType
|
columnType | string |
Тип столбца |
|
|
минимальное значение
|
minValue | integer |
Возвращает или задает минимальное значение. |
|
|
максимальное значение
|
maxValue | integer |
Возвращает или задает максимальное значение. |
|
|
showCenterLabel
|
showCenterLabel | boolean |
Возвращает или задает значение, указывающее, является ли [show center label]. |
|
|
showValue
|
showValue | boolean |
Возвращает или задает значение, указывающее, является ли [показать значение]. |
|
|
maxDecimals
|
maxDecimals | integer |
Возвращает или задает максимальные цифры после запятой. |
|
|
textFieldSize
|
textFieldSize | string |
TextFieldSize |
|
|
автозавершение
|
autocomplete | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.SurveyElement автоматически завершенным. |
|
|
hasPlaceholder
|
hasPlaceholder | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр заполнитель. |
|
|
isPassword
|
isPassword | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр паролем. |
|
|
minMaxValidation
|
minMaxValidation | boolean |
Возвращает или задает значение, указывающее, является ли [минимальная максимальная проверка]. |
|
|
minimumCheckedChoices
|
minimumCheckedChoices | integer |
Возвращает или задает минимальные проверенные варианты. |
|
|
maximumCheckedChoices
|
maximumCheckedChoices | integer |
Возвращает или задает максимально проверенные варианты. |
|
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
hasNotAvailableChoice
|
hasNotAvailableChoice | True | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр недоступный выбор. |
|
randomizeColumns
|
randomizeColumns | True | boolean |
Возвращает или задает значение, указывающее, [случайные столбцы]. |
|
choiceType
|
choiceType | True | string |
ChoiceType |
|
randomizeRows
|
randomizeRows | boolean |
Возвращает или задает значение, указывающее, [случайные строки]. |
|
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
код
|
code | True | string |
Возвращает или задает код. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
|
excludeFromRandomization
|
excludeFromRandomization | True | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
numberOfRanks
|
numberOfRanks | integer |
Возвращает или задает количество рангов. |
|
|
hasStartText
|
hasStartText | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр начальный текст. |
|
|
enableMeasurement
|
enableMeasurement | boolean |
Возвращает или задает значение, указывающее, включена ли [включить измерение]. |
|
|
showButtons
|
showButtons | boolean |
Возвращает или задает значение, указывающее, [показать кнопки]. |
|
|
likeKey
|
likeKey | string |
Возвращает или задает такой ключ. |
|
|
не нравитсяKey
|
dislikeKey | string |
Возвращает или задает нелюбовный ключ. |
|
|
interviewState
|
interviewState | string |
Возвращает или задает состояние ответа. |
|
|
actionType
|
actionType | True | string |
КвотаAction |
|
от / из / с (context-dependent)
|
from | string |
Возвращает или задает отправителя. |
|
|
Кому
|
to | string |
Возвращает или задает приемник. |
|
|
valueAssignmentType
|
valueAssignmentType | string |
ValueAssignmentType |
|
|
variableName
|
variableName | string |
Возвращает или задает имя переменной. |
|
|
executionBehavior
|
executionBehavior | string |
ExecutionBehavior |
|
|
apiCallMethod
|
apiCallMethod | string |
ApiCallMethod |
|
|
headers
|
headers | string |
Возвращает или задает заголовки. |
|
|
externalUri
|
externalUri | string |
Возвращает или задает внешний универсальный код ресурса (URI). |
|
|
scriptType
|
scriptType | string |
ScriptType |
|
|
содержимое
|
content | string |
Возвращает или задает содержимое. |
|
|
hasRatingLabels
|
hasRatingLabels | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр метки оценки. |
|
|
evaluateAsJson
|
evaluateAsJson | boolean |
Возвращает или задает значение, указывающее, вычисляется ли [как json]. |
|
|
autocompleteListVariable
|
autocompleteListVariable | string |
Возвращает или задает переменную списка автозаполнения. |
|
|
arrangementMode
|
arrangementMode | string |
ArrangementMode |
|
|
enableAnimation
|
enableAnimation | boolean |
Возвращает или задает значение, указывающее, включена ли [включить анимацию]. |
|
|
useSmiley
|
useSmiley | boolean |
Возвращает или задает значение, указывающее, используется ли [использовать смайлику]. |
|
|
hasPrompt
|
hasPrompt | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр запрос. |
|
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
variableName
|
variableName | True | string |
Возвращает или задает имя переменной. |
|
defaultTextOverrides
|
defaultTextOverrides | object |
Возвращает или задает переопределение текста по умолчанию. |
|
|
surveyDesignLayout
|
surveyDesignLayout | integer |
Возвращает или задает макет макета опроса. |
|
|
matrixSubQuestionSize
|
matrixSubQuestionSize | string |
MatrixSubQuestionSize |
|
|
имя
|
name | string |
Возвращает или задает имя. |
|
|
type
|
type | string |
Возвращает или задает тип. |
|
|
languageCode
|
languageCode | True | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
|
|
анонимныйmode
|
anonymizingMode | True | string |
АнонимизацияMode |
|
LogIp
|
logIp | True | boolean |
Возвращает или задает значение, указывающее, является ли [ip-адрес журнала]. |
|
logUserAgent
|
logUserAgent | True | boolean |
Возвращает или задает значение, указывающее, является ли [агент пользователя журнала]. |
|
logRefererer
|
logReferer | True | boolean |
Возвращает или задает значение, указывающее, является ли [рефератор журнала]. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API UpdateSurvey.
- Тело
- UpdateSurveyResponse
Обновление элементов
Это действие позволяет обновить список участников.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | string |
Возвращает или задает клиент. |
|
|
panelId
|
panelId | True | integer |
Возвращает или задает идентификатор панели. |
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
|
столбцов
|
fields | True | object |
Возвращает или задает поля. |
|
createdAt
|
createdAt | date-time |
Возвращает или задает созданный объект. |
|
|
создано кем
|
createdBy | string |
Возвращает или задает созданный объект. |
|
|
обновлено
|
updatedAt | date-time |
Возвращает или задает обновленное значение. |
|
|
обновленоBy
|
updatedBy | string |
Возвращает или задает обновленный. |
|
|
id
|
id | string |
Идентификатор интервью |
|
|
государство
|
state | string |
Возвращает или задает состояние. |
|
|
surveyId
|
surveyId | integer |
Идентификатор опроса |
|
|
surveyVersionId
|
surveyVersionId | integer |
Идентификатор версии опроса |
|
|
surveyName
|
surveyName | string |
Имя опроса |
|
|
surveyState
|
surveyState | string |
Возвращает или задает состояние опроса. |
|
|
answersLink
|
answersLink | string |
Ссылка на страницу печати ответов |
|
|
interviewLink
|
interviewLink | string |
Возвращает или задает ссылку на интервью. |
|
|
startDate
|
startDate | string |
Возвращает или задает дату начала. |
|
|
Дата окончания
|
endDate | string |
Возвращает или задает дату окончания. |
|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API UpdateMembers.
Отправить сообщение электронной почты
Это действие обеспечивает возможность отправки почты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
messageTemplateId
|
messageTemplateId | integer |
Возвращает или задает идентификатор шаблона сообщения. |
|
|
имя
|
name | string |
Возвращает или задает имя. |
|
|
type
|
type | string |
Возвращает или задает тип. |
|
|
languageCode
|
languageCode | True | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
|
|
language
|
language | True | string |
Возвращает или задает язык. |
|
субъект
|
subject | string |
Возвращает или задает тему. |
|
|
body
|
body | string |
Возвращает или задает текст. |
|
|
от / из / с (context-dependent)
|
from | True | string |
Возвращает или задает из. |
|
fromName
|
fromName | string |
Возвращает или задает из имени. |
|
|
Кому
|
to | True | string |
Возвращает или задает значение. |
|
toName
|
toName | string |
Преобразуется в имя. |
|
|
replyTo
|
replyTo | string |
Возвращает или задает ответ. |
|
|
replyToName
|
replyToName | string |
Возвращает или задает имя ответа. |
Возвращаемое значение
Этот класс представляет параметры возврата для API ExecuteSendMail.
Панель обновления
Это действие позволяет обновить панель.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | string |
Возвращает или задает клиент. |
|
|
panelId
|
panelId | True | integer |
Возвращает или задает идентификатор панели. |
|
id
|
id | integer |
Идентификатор поля. Это обязательное поле в случае переименования. |
|
|
имя
|
name | string |
Имя поля. Это обязательное поле. |
|
|
type
|
type | string |
PanelMemberFieldType |
|
|
value
|
value |
значение поля ; Тип значения должен соответствовать свойству Type. |
||
|
Удалены поля
|
removedFields | array of integer |
Возвращает или задает удаленные поля. |
|
|
id
|
id | integer |
Идентификатор поля. Это обязательное поле в случае переименования. |
|
|
имя
|
name | string |
Имя поля. Это обязательное поле. |
|
|
type
|
type | string |
PanelMemberFieldType |
|
|
value
|
value |
значение поля ; Тип значения должен соответствовать свойству Type. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API WritePanel.
- Тело
- WritePanelResponse
Панель чтения
Это действие обеспечивает возможность чтения определения панели.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | string |
Возвращает или задает клиент. |
|
|
panelId
|
panelId | True | integer |
Возвращает или задает идентификатор панели. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadPanelDefinition.
Приглашение участников
Это действие предлагает возможность пригласить участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
surveyId
|
surveyId | True | integer |
Идентификатор опроса |
|
panelId
|
panelId | True | integer |
Возвращает или задает идентификатор панели. |
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
|
memberIds
|
memberIds | array of integer |
Возвращает или задает идентификаторы элементов панели. |
|
|
messageTemplateId
|
messageTemplateId | True | integer |
Возвращает или задает идентификатор шаблона сообщения. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
|
type
|
type | string |
Возвращает или задает тип. |
|
|
languageCode
|
languageCode | True | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
|
|
scheduleDateTime
|
scheduleDateTime | date-time |
Возвращает или задает время расписания. |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
канал
|
channel | string |
Канал распространения |
|
|
asyncProcess
|
asyncProcess | boolean |
Возвращает или задает асинхронный процесс. |
|
|
interviewExpiryDate
|
interviewExpiryDate | string |
Возвращает или задает дату окончания срока действия интервью. |
|
|
от / из / с (context-dependent)
|
from | string |
Возвращает или задает из. |
|
|
fromName
|
fromName | string |
Возвращает или задает из имени. |
|
|
replyTo
|
replyTo | string |
Возвращает или задает ответ. |
|
|
replyToName
|
replyToName | string |
Возвращает или задает имя ответа. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API InviteMembers.
Приглашение участников
Это действие предоставляет возможность создавать и приглашать участников.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
|
surveyId
|
surveyId | True | integer |
Возвращает или задает идентификатор опроса. |
|
panelId
|
panelId | True | integer |
Возвращает или задает идентификатор панели. |
|
канал
|
channel | True | string |
Канал распространения |
|
messageTemplateId
|
messageTemplateId | True | integer |
Возвращает или задает идентификатор шаблона сообщения. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
|
type
|
type | string |
Возвращает или задает тип. |
|
|
languageCode
|
languageCode | True | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
|
столбцов
|
fields | True | object |
Возвращает или задает поля. |
|
createdAt
|
createdAt | date-time |
Возвращает или задает созданный объект. |
|
|
создано кем
|
createdBy | string |
Возвращает или задает созданный объект. |
|
|
обновлено
|
updatedAt | date-time |
Возвращает или задает обновленное значение. |
|
|
обновленоBy
|
updatedBy | string |
Возвращает или задает обновленный. |
|
|
id
|
id | string |
Идентификатор интервью |
|
|
государство
|
state | string |
Возвращает или задает состояние. |
|
|
surveyId
|
surveyId | integer |
Идентификатор опроса |
|
|
surveyVersionId
|
surveyVersionId | integer |
Идентификатор версии опроса |
|
|
surveyName
|
surveyName | string |
Имя опроса |
|
|
surveyState
|
surveyState | string |
Возвращает или задает состояние опроса. |
|
|
answersLink
|
answersLink | string |
Ссылка на страницу печати ответов |
|
|
interviewLink
|
interviewLink | string |
Возвращает или задает ссылку на интервью. |
|
|
startDate
|
startDate | string |
Возвращает или задает дату начала. |
|
|
Дата окончания
|
endDate | string |
Возвращает или задает дату окончания. |
|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
|
|
scheduleDateTime
|
scheduleDateTime | string |
Возвращает или задает время даты расписания. |
|
|
asyncProcess
|
asyncProcess | boolean |
Возвращает или задает асинхронный процесс. |
|
|
interviewExpiryDate
|
interviewExpiryDate | string |
Возвращает или задает дату окончания срока действия интервью. |
|
|
от / из / с (context-dependent)
|
from | string |
Возвращает или задает из. |
|
|
fromName
|
fromName | string |
Возвращает или задает из имени. |
|
|
replyTo
|
replyTo | string |
Возвращает или задает ответ. |
|
|
replyToName
|
replyToName | string |
Возвращает или задает имя ответа. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API CreateAndInviteMembers.
Сброс интервью
Это действие обеспечивает возможность сброса ответа члена панели.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
|
|
interviewId
|
interviewId | uuid |
Возвращает или задает идентификатор интервью. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ResetInterview.
Скачивание PDF-файла интервью
Это действие позволяет скачать ответы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Tenant
|
tenant | True | string |
Клиент. |
|
SurveyId
|
surveyId | True | integer |
Идентификатор опроса. |
|
InterviewId
|
interviewId | True | uuid |
Идентификатор интервью. |
|
Показать частично завершенное
|
showPartialCompleted | boolean |
Значение |
|
|
Региональные настройки
|
locale | string |
Языковой стандарт. |
|
|
Thmezone
|
timeZone | string |
Часовой пояс. |
|
|
isCancellationRequested
|
isCancellationRequested | boolean | ||
|
canBeCanceled
|
canBeCanceled | boolean | ||
|
isInvalid
|
isInvalid | boolean | ||
|
isClosed
|
isClosed | boolean |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DownloadAnswers.
Создание артефакта
Это действие предоставляет возможность создания нового артефакта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
workspaceId
|
workspaceId | integer |
Возвращает или задает идентификатор рабочей области. |
|
|
путь
|
path | string |
Возвращает или задает путь. |
Возвращаемое значение
Этот класс представляет ответ API CreateArtifact.
Создание веб-перехватчика
Это действие позволяет создать веб-перехватчик.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
eventType
|
eventType | string |
Тип события |
|
|
entityIdentifier
|
entityIdentifier | string |
Возвращает или задает идентификатор сущности. |
|
|
securityToken
|
securityToken | string |
Возвращает или задает маркер безопасности. |
|
|
webHookUrl
|
webHookUrl | string |
Возвращает или задает URL-адрес веб-перехватчика. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API CreateWebHook.
Создание опроса
Это действие обеспечивает возможность создания опроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
workspaceId
|
workspaceId | True | integer |
Возвращает или задает идентификатор рабочей области. |
|
имя
|
name | True | string |
Возвращает или задает имя. |
|
allowMultipleParticipation
|
allowMultipleParticipation | True | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить несколько участников]. |
|
allowNavigateBack
|
allowNavigateBack | True | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить возврат]. |
|
allowSaveProgress
|
allowSaveProgress | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить ход сохранения]. |
|
|
randomizeSections
|
randomizeSections | True | boolean |
Возвращает или задает значение, указывающее, [случайные разделы]. |
|
enableAutoScroll
|
enableAutoScroll | boolean |
Возвращает или задает значение, указывающее, включена ли [включить автоматическую прокрутку]. |
|
|
enableCodeAccess
|
enableCodeAccess | boolean |
Возвращает или задает значение, указывающее, включен ли [включить доступ к коду]. |
|
|
accessType
|
accessType | string |
ТипДоступа |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
associatedPanels
|
associatedPanels | array of integer |
Возвращает или задает идентификатор панели. |
|
|
codeAccessMode
|
codeAccessMode | True | string |
AuthenticationType |
|
enablePanelSync
|
enablePanelSync | boolean |
Возвращает или задает значение, указывающее, включена ли [синхронизация панели]. |
|
|
panelSyncBehaviour
|
panelSyncBehaviour | string |
PanelSyncBehaviour |
|
|
идентификатор
|
identifier | string |
Возвращает или задает идентификатор. |
|
|
panelField
|
panelField | string |
Возвращает или задает поле панели. |
|
|
Язык defaultLanguage
|
defaultLanguage | True | string |
Возвращает или задает язык по умолчанию. |
|
Дата окончания
|
endDate | date-time |
Возвращает или задает дату окончания. |
|
|
Языки
|
languages | True | array of string |
Возвращает или задает языки. |
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
имя
|
name | True | string |
Возвращает или задает имя. |
|
randomizePages
|
randomizePages | True | boolean |
Возвращает или задает значение, указывающее, [случайные страницы]. |
|
excludeFromRandomization
|
excludeFromRandomization | True | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
elementType
|
elementType | True | string |
ElementType |
|
код
|
code | string |
Возвращает или задает код. |
|
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
|
languageCode
|
languageCode | True | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
|
|
hasHintText
|
hasHintText | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр текст подсказки. |
|
|
hasNotAvailableChoice
|
hasNotAvailableChoice | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр недоступный выбор. |
|
|
forceResponse
|
forceResponse | boolean |
Возвращает или задает значение, указывающее, является ли [принудительный ответ]. |
|
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
код
|
code | True | string |
Возвращает или задает код. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
|
allowTextEntry
|
allowTextEntry | True | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить запись текста]. |
|
forceInput
|
forceInput | True | boolean |
Возвращает или задает значение, указывающее, является ли [принудительное ввод]. |
|
автозавершение
|
autocomplete | True | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.Choice автозавершением. |
|
исключительный
|
exclusive | True | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.Choice эксклюзивным. |
|
excludeFromRandomization
|
excludeFromRandomization | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
|
validationType
|
validationType | True | string |
Проверка содержимого |
|
ранняяDate
|
earliestDate | string |
Возвращает или задает раннюю дату. |
|
|
latestDate
|
latestDate | string |
Возвращает или задает последнюю дату. |
|
|
минимальное значение
|
minValue | double |
Возвращает или задает минимальное значение. |
|
|
максимальное значение
|
maxValue | double |
Возвращает или задает максимальное значение. |
|
|
decimalPlaces
|
decimalPlaces | integer |
Возвращает или задает десятичные разряды. |
|
|
disableThousandSeparator
|
disableThousandSeparator | boolean |
Возвращает или задает разделитель отключаемой тысячи. |
|
|
conditionAction
|
conditionAction | True | string |
FilterAction |
|
autocompleteListVariable
|
autocompleteListVariable | string |
Возвращает или задает переменную списка автозаполнения. |
|
|
randomizeChoices
|
randomizeChoices | boolean |
Возвращает или задает значение, указывающее, является ли [случайный выбор]. |
|
|
columnType
|
columnType | string |
Тип столбца |
|
|
минимальное значение
|
minValue | integer |
Возвращает или задает минимальное значение. |
|
|
максимальное значение
|
maxValue | integer |
Возвращает или задает максимальное значение. |
|
|
showCenterLabel
|
showCenterLabel | boolean |
Возвращает или задает значение, указывающее, является ли [show center label]. |
|
|
showValue
|
showValue | boolean |
Возвращает или задает значение, указывающее, является ли [показать значение]. |
|
|
maxDecimals
|
maxDecimals | integer |
Возвращает или задает максимальные цифры после запятой. |
|
|
textFieldSize
|
textFieldSize | string |
TextFieldSize |
|
|
автозавершение
|
autocomplete | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.SurveyElement автоматически завершенным. |
|
|
hasPlaceholder
|
hasPlaceholder | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр заполнитель. |
|
|
isPassword
|
isPassword | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр паролем. |
|
|
minMaxValidation
|
minMaxValidation | boolean |
Возвращает или задает значение, указывающее, является ли [минимальная максимальная проверка]. |
|
|
minimumCheckedChoices
|
minimumCheckedChoices | integer |
Возвращает или задает минимальные проверенные варианты. |
|
|
maximumCheckedChoices
|
maximumCheckedChoices | integer |
Возвращает или задает максимально проверенные варианты. |
|
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
hasNotAvailableChoice
|
hasNotAvailableChoice | True | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр недоступный выбор. |
|
randomizeColumns
|
randomizeColumns | True | boolean |
Возвращает или задает значение, указывающее, [случайные столбцы]. |
|
choiceType
|
choiceType | True | string |
ChoiceType |
|
randomizeRows
|
randomizeRows | boolean |
Возвращает или задает значение, указывающее, [случайные строки]. |
|
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
код
|
code | True | string |
Возвращает или задает код. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
|
excludeFromRandomization
|
excludeFromRandomization | True | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
numberOfRanks
|
numberOfRanks | integer |
Возвращает или задает количество рангов. |
|
|
hasStartText
|
hasStartText | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр начальный текст. |
|
|
enableMeasurement
|
enableMeasurement | boolean |
Возвращает или задает значение, указывающее, включена ли [включить измерение]. |
|
|
showButtons
|
showButtons | boolean |
Возвращает или задает значение, указывающее, [показать кнопки]. |
|
|
likeKey
|
likeKey | string |
Возвращает или задает такой ключ. |
|
|
не нравитсяKey
|
dislikeKey | string |
Возвращает или задает нелюбовный ключ. |
|
|
interviewState
|
interviewState | string |
Возвращает или задает состояние ответа. |
|
|
actionType
|
actionType | True | string |
КвотаAction |
|
от / из / с (context-dependent)
|
from | string |
Возвращает или задает отправителя. |
|
|
Кому
|
to | string |
Возвращает или задает приемник. |
|
|
valueAssignmentType
|
valueAssignmentType | string |
ValueAssignmentType |
|
|
variableName
|
variableName | string |
Возвращает или задает имя переменной. |
|
|
executionBehavior
|
executionBehavior | string |
ExecutionBehavior |
|
|
apiCallMethod
|
apiCallMethod | string |
ApiCallMethod |
|
|
headers
|
headers | string |
Возвращает или задает заголовки. |
|
|
externalUri
|
externalUri | string |
Возвращает или задает внешний универсальный код ресурса (URI). |
|
|
scriptType
|
scriptType | string |
ScriptType |
|
|
содержимое
|
content | string |
Возвращает или задает содержимое. |
|
|
hasRatingLabels
|
hasRatingLabels | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр метки оценки. |
|
|
evaluateAsJson
|
evaluateAsJson | boolean |
Возвращает или задает значение, указывающее, вычисляется ли [как json]. |
|
|
autocompleteListVariable
|
autocompleteListVariable | string |
Возвращает или задает переменную списка автозаполнения. |
|
|
arrangementMode
|
arrangementMode | string |
ArrangementMode |
|
|
enableAnimation
|
enableAnimation | boolean |
Возвращает или задает значение, указывающее, включена ли [включить анимацию]. |
|
|
useSmiley
|
useSmiley | boolean |
Возвращает или задает значение, указывающее, используется ли [использовать смайлику]. |
|
|
hasPrompt
|
hasPrompt | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр запрос. |
|
|
id
|
id | True | integer |
Возвращает или задает идентификатор. |
|
variableName
|
variableName | True | string |
Возвращает или задает имя переменной. |
|
defaultTextOverrides
|
defaultTextOverrides | object |
Возвращает или задает переопределение текста по умолчанию. |
|
|
surveyDesignLayout
|
surveyDesignLayout | integer |
Возвращает или задает макет макета опроса. |
|
|
matrixSubQuestionSize
|
matrixSubQuestionSize | string |
MatrixSubQuestionSize |
|
|
имя
|
name | string |
Возвращает или задает имя. |
|
|
type
|
type | string |
Возвращает или задает тип. |
|
|
languageCode
|
languageCode | True | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
|
|
анонимныйmode
|
anonymizingMode | True | string |
АнонимизацияMode |
|
LogIp
|
logIp | True | boolean |
Возвращает или задает значение, указывающее, является ли [ip-адрес журнала]. |
|
logUserAgent
|
logUserAgent | True | boolean |
Возвращает или задает значение, указывающее, является ли [агент пользователя журнала]. |
|
logRefererer
|
logReferer | True | boolean |
Возвращает или задает значение, указывающее, является ли [рефератор журнала]. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API CreateSurvey.
- Тело
- CreateSurveyResponse
Создание панели или примера
Это действие позволяет создать новую панель.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
workspaceId
|
workspaceId | True | integer |
Возвращает или задает идентификатор рабочей области. |
|
имя
|
name | True | string |
Возвращает или задает имя панели. |
|
panelType
|
panelType | True | string |
PanelModelType |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API CreatePanel.
- Тело
- CreatePanelResponse
Создание участников
Это действие позволяет создать список участников.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | string |
Возвращает или задает клиент. |
|
|
panelId
|
panelId | True | integer |
Возвращает или задает идентификатор панели. |
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
|
столбцов
|
fields | True | object |
Возвращает или задает поля. |
|
createdAt
|
createdAt | date-time |
Возвращает или задает созданный объект. |
|
|
создано кем
|
createdBy | string |
Возвращает или задает созданный объект. |
|
|
обновлено
|
updatedAt | date-time |
Возвращает или задает обновленное значение. |
|
|
обновленоBy
|
updatedBy | string |
Возвращает или задает обновленный. |
|
|
id
|
id | string |
Идентификатор интервью |
|
|
государство
|
state | string |
Возвращает или задает состояние. |
|
|
surveyId
|
surveyId | integer |
Идентификатор опроса |
|
|
surveyVersionId
|
surveyVersionId | integer |
Идентификатор версии опроса |
|
|
surveyName
|
surveyName | string |
Имя опроса |
|
|
surveyState
|
surveyState | string |
Возвращает или задает состояние опроса. |
|
|
answersLink
|
answersLink | string |
Ссылка на страницу печати ответов |
|
|
interviewLink
|
interviewLink | string |
Возвращает или задает ссылку на интервью. |
|
|
startDate
|
startDate | string |
Возвращает или задает дату начала. |
|
|
Дата окончания
|
endDate | string |
Возвращает или задает дату окончания. |
|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API CreateMembers.
Стимулы для чтения
Это действие возвращает доступные стимулы и ваучеры для прошедшего проверку подлинности пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет параметры запроса для API ReadIncentiveList.
Удаление артефакта
Это действие обеспечивает возможность удаления артефакта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
путь
|
path | string |
Возвращает или задает путь. |
|
|
filename
|
filename | string |
Возвращает или задает имя файла. |
|
|
workspaceId
|
workspaceId | integer |
Возвращает или задает идентификатор рабочей области. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DeleteArtifact.
Удаление веб-перехватчика
Это действие обеспечивает возможность удаления веб-перехватчика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
webHookId
|
webHookId | uuid |
Возвращает или задает идентификатор веб-перехватчика. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DeleteWebHook.
Удаление интервью
Это действие позволяет удалить интервью.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
interviewId
|
interviewId | uuid |
Возвращает или задает идентификатор интервью. |
|
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DeleteInterview.
Удаление опроса
Это действие обеспечивает возможность удаления опроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
surveyId
|
surveyId | True | integer |
Возвращает или задает идентификатор опроса. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DeleteSurvey.
- Тело
- DeleteSurveyResponse
Удаление панели
Это действие обеспечивает возможность удаления панели.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
panelId
|
panelId | True | integer |
Возвращает или задает пример идентификатора. |
|
keepInterviews
|
keepInterviews | boolean |
Возвращает или задает значение, указывающее, следует ли [хранить интервью]. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DeleteSample.
- Тело
- DeletePanelResponse
Удаление проекта выборки
Это действие позволяет удалить проект выборки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
|
keepInterviews
|
keepInterviews | boolean |
Возвращает или задает значение, указывающее, следует ли [хранить интервью]. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DeleteSamplingProject.
Удаление распространителя
Это действие обеспечивает возможность удаления распространителя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификаторДистрибьютора
|
distributorId | True | integer |
Возвращает или задает идентификатор распространителя. |
|
keepInterviews
|
keepInterviews | boolean |
Возвращает или задает значение, указывающее, следует ли [хранить интервью]. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DeleteDistributor.
Удаление элементов
Это действие обеспечивает возможность удаления участников.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
panelId
|
panelId | True | integer |
Возвращает или задает идентификатор панели. |
|
panelMembersIds
|
panelMembersIds | True | array of integer |
Возвращает или задает идентификатор члена панели. |
|
keepInterviews
|
keepInterviews | boolean |
Возвращает или задает значение, указывающее, следует ли [хранить интервью]. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API DeleteMember.
Чтение Opt-Outs
Это действие обеспечивает возможность чтения всех Opt-Outs рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
panelId
|
panelId | integer |
Возвращает или задает идентификатор панели. |
|
|
workspaceId
|
workspaceId | integer |
Возвращает или задает идентификатор рабочей области. |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет параметры возврата для API ReadOptOutList.
Чтение артефактов
Это действие предлагает возможность прочитать список артефактов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
путь
|
path | string |
Возвращает или задает путь. |
|
|
workspaceId
|
workspaceId | integer |
Возвращает или задает идентификатор рабочей области. |
Возвращаемое значение
Этот класс представляет параметры запроса для API ReadArtifactList.
Чтение веб-перехватчиков
Это действие позволяет считывать список веб-перехватчиков.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
eventType
|
eventType | string |
Тип события |
|
|
entityIdentifier
|
entityIdentifier | string |
Возвращает или задает идентификатор сущности. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadWebHookList.
Чтение интервью
Это действие предлагает возможность прочитать данные интервью.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | True | string |
Возвращает или задает клиент. |
|
interviewId
|
interviewId | True | uuid |
Возвращает или задает идентификатор интервью. |
|
surveyId
|
surveyId | True | integer |
Возвращает или задает идентификатор опроса. |
|
loadSurveyDefinition
|
loadSurveyDefinition | boolean |
Возвращает или задает значение, указывающее, является ли [определение опроса нагрузки]. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadInterviewData.
Чтение интервью
Это действие предлагает возможность прочитать список интервью.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | string |
Возвращает или задает клиент. |
|
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
|
|
fieldsToDownload
|
fieldsToDownload | array of string |
Возвращает или задает запрошенные столбцы. |
|
|
loadCodePlan
|
loadCodePlan | boolean |
Возвращает или задает значение, указывающее, является ли [план кода нагрузки]. |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadInterviewList.
Чтение интервью Compact
Это действие предлагает возможность прочитать список интервью компактным.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | string |
Возвращает или задает клиент. |
|
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
|
|
fieldsToDownload
|
fieldsToDownload | array of string |
Возвращает или задает запрошенные столбцы. |
|
|
loadCodePlan
|
loadCodePlan | boolean |
Возвращает или задает значение, указывающее, является ли [план кода нагрузки]. |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadInterviewListCompact.
Чтение кредитного баланса
Это действие возвращает кредитный баланс опроса для прошедшего проверку подлинности пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
|
object |
Этот класс представляет параметры запроса для API ReadCreditBalance. |
Возвращаемое значение
Этот класс представляет параметры возврата для API ReadCreditBalance.
Чтение опроса
Это действие предоставляет возможность прочитать опрос.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | string |
Возвращает или задает клиент. |
|
|
surveyId
|
surveyId | True | integer |
Возвращает или задает идентификатор опроса. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadSurveyDefinition.
- Тело
- ReadSurveyResponse
Чтение опросов
Это действие предоставляет возможность прочитать все доступные опросы данной рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
workspaceId
|
workspaceId | True | integer |
Возвращает или задает идентификатор рабочей области. |
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет параметры ответа для API ReadSurveyList.
Чтение отказов
Это действие предлагает возможность прочитать список отказов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
surveyId
|
surveyId | True | integer |
Возвращает или задает идентификатор опроса. |
|
panelId
|
panelId | integer |
Возвращает или задает идентификатор панели. |
|
|
Дистрибьюторов
|
distributors | array of integer |
Возвращает или задает распространители. |
|
|
invitationType
|
invitationType | string |
Пригласительный тип |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadBounceList.
Чтение переходов рабочих процессов
Это действие обеспечивает возможность считывания всех переходов рабочих процессов, относящихся к рабочему процессу.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
workflow
|
workflow | True | string |
Тип рабочего процесса |
|
currentState
|
currentState | True | string |
Возвращает или задает состояние текущего. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadWorkflowTransitions.
Чтение проекта выборки
Это действие позволяет прочитать проект выборки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadSamplingProject.
Чтение рабочих областей
Это действие обеспечивает возможность чтения всех доступных рабочих областей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет параметры запроса для API ReadWorkspaceList.
Чтение распространителей
Это действие позволяет прочитать список распространителя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
|
|
panelId
|
panelId | integer |
Возвращает или задает идентификатор панели. |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadDistributorList.
Чтение ссылок опроса
Это действие предоставляет возможность считывать ссылки на опрос.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
Возвращаемое значение
Этот класс представляет ответ API ReadSurveyLinks.
Чтение транзакций поощрения
Это действие возвращает обзор всех доходов и расходов, связанных с кредитами опроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadIncentiveTransactionList.
Чтение членов
Это действие обеспечивает возможность чтения членов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
tenant
|
tenant | string |
Возвращает или задает клиент. |
|
|
panelId
|
panelId | True | integer |
Возвращает или задает идентификатор панели. |
|
интервьюRequired
|
interviewsRequired | True | boolean |
Возвращает или задает значение, указывающее, требуется ли информация о сеансе. |
|
fieldsToDownload
|
fieldsToDownload | array of string |
Возвращает или задает поля для скачивания. |
|
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadMemberList.
Чтение шаблонов сообщений
Это действие позволяет получать все настроенные шаблоны сообщений для электронной почты и SMS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
workspaceId
|
workspaceId | integer |
Возвращает или задает идентификатор рабочей области. |
|
|
language
|
language | True | string |
Возвращает или задает язык. |
|
союз
|
conjunction | True | string |
Союз |
|
conditionType
|
conditionType | True | string |
ConditionType |
|
идентификатор
|
identifier | True | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
|
value
|
value | True | string |
Возвращает или задает значение. |
|
variableType
|
variableType | string |
VariableType |
|
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
|
|
pageSize
|
pageSize | True | integer |
Возвращает или задает размер страницы. |
|
page
|
page | True | integer |
Возвращает или задает страницу. |
|
orderField
|
orderField | string |
Возвращает или задает поле заказа. |
|
|
orderDirection
|
orderDirection | string |
OrderDirection |
Возвращаемое значение
Этот класс представляет возвращаемые параметры для API ReadMessageTemplateList.
Определения
ТипДоступа
ActionElement
Этот класс представляет собой конец действия опроса для полного завершения или завершения экрана или квоты.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
actionType
|
actionType | ActionType |
КвотаAction |
|
endOfSurveyText
|
endOfSurveyText | array of TranslationElement |
Возвращает или задает конец текста опроса. |
|
forwardUrl
|
forwardUrl | array of TranslationElement |
Возвращает или задает URL-адрес пересылки. |
ТипДействия
АнонимизацияConfiguration
Этот класс содержит параметры анонимизации, которые можно применить к группе рабочих областей, рабочей области или отдельному опросу.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
анонимныйmode
|
anonymizingMode | AnonymizingMode |
АнонимизацияMode |
|
LogIp
|
logIp | boolean |
Возвращает или задает значение, указывающее, является ли [ip-адрес журнала]. |
|
logUserAgent
|
logUserAgent | boolean |
Возвращает или задает значение, указывающее, является ли [агент пользователя журнала]. |
|
logRefererer
|
logReferer | boolean |
Возвращает или задает значение, указывающее, является ли [рефератор журнала]. |
АнонимизацияMode
ApiCallMethod
ArrangementMode
BounceElement
Этот класс представляет собой конец действия опроса для полного завершения или завершения экрана или квоты.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
|
interviewId
|
interviewId | uuid |
Возвращает или задает идентификатор интервью. |
|
panelId
|
panelId | integer |
Возвращает или задает идентификатор панели. |
|
panelMemberId
|
panelMemberId | integer |
Возвращает или задает идентификатор члена панели. |
|
bounceType
|
bounceType | BounceType |
BounceType |
|
отметка времени
|
timestamp | date-time |
Возвращает или задает метку времени. |
|
государство
|
state | string |
Возвращает или задает состояние. |
|
причина
|
reason | string |
Возвращает или задает причину. |
|
электронная почта
|
string |
Возвращает или задает сообщение электронной почты. |
|
|
phone
|
phone | integer |
Возвращает или задает телефон. |
|
invitationType
|
invitationType | InvitationType |
Пригласительный тип |
BounceType
Выбор
Этот класс представляет собой один выбор, который можно использовать в каждом типе вопросов выбора.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
код
|
code | string |
Возвращает или задает код. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
текст
|
text | array of TranslationElement |
Возвращает или задает переводы текста. |
|
allowTextEntry
|
allowTextEntry | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить запись текста]. |
|
forceInput
|
forceInput | boolean |
Возвращает или задает значение, указывающее, является ли [принудительное ввод]. |
|
автозавершение
|
autocomplete | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.Choice автозавершением. |
|
autocompleteText
|
autocompleteText | array of TranslationElement |
Возвращает или задает автозавершение текстовых переводов. |
|
исключительный
|
exclusive | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.Choice эксклюзивным. |
|
excludeFromRandomization
|
excludeFromRandomization | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
contentValidation
|
contentValidation | ContentValidation |
Этот класс представляет проверку содержимого внутри опроса. |
|
condition
|
condition | ConditionDefinition |
Этот класс представляет определение элементов условий. |
|
autocompleteListVariable
|
autocompleteListVariable | string |
Возвращает или задает переменную списка автозаполнения. |
ChoiceType
CodeAccessMode
ColItem
Этот класс представляет ячейку ответа опроса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
Возвращает или задает идентификатор. |
|
value
|
value |
Возвращает или задает значение. |
ColumnGroup
Этот класс представляет группу столбцов внутри сложных типов вопросов, таких как вопросы матрицы.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
текст
|
text | array of TranslationElement |
Возвращает или задает переводы текста. |
|
hasNotAvailableChoice
|
hasNotAvailableChoice | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр недоступный выбор. |
|
notAvailableChoiceText
|
notAvailableChoiceText | array of TranslationElement |
Возвращает или задает недоступные текстовые переводы выбора. |
|
randomizeColumns
|
randomizeColumns | boolean |
Возвращает или задает значение, указывающее, [случайные столбцы]. |
|
prompt
|
prompt | array of TranslationElement |
Возвращает или задает запрос. |
|
choiceType
|
choiceType | ChoiceType |
ChoiceType |
|
choices
|
choices | array of Choice |
Возвращает или задает варианты. |
|
condition
|
condition | ConditionDefinition |
Этот класс представляет определение элементов условий. |
Тип столбца
Состояние
Этот класс является основой для всех элементов условия.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
союз
|
conjunction | Conjunction |
Союз |
|
conditionType
|
conditionType | ConditionType |
ConditionType |
|
идентификатор
|
identifier | string |
Возвращает или задает идентификатор. |
|
conditionOperator
|
conditionOperator | ConditionOperator |
ConditionOperator |
|
value
|
value | string |
Возвращает или задает значение. |
|
variableType
|
variableType | VariableType |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Возвращает или задает значение, указывающее, является ли [значение json]. |
|
jsonPath
|
jsonPath | string |
Возвращает или задает путь json. |
ConditionAction
ConditionDefinition
Этот класс представляет определение элементов условий.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
conditionAction
|
conditionAction | ConditionAction |
FilterAction |
|
азы
|
elements | array of Condition |
Возвращает или задает элементы. |
ConditionOperator
ConditionType
Союз
Проверка содержимого
Этот класс представляет проверку содержимого внутри опроса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
validationType
|
validationType | ContentValidationType |
Проверка содержимого |
|
ранняяDate
|
earliestDate | string |
Возвращает или задает раннюю дату. |
|
latestDate
|
latestDate | string |
Возвращает или задает последнюю дату. |
|
минимальное значение
|
minValue | double |
Возвращает или задает минимальное значение. |
|
максимальное значение
|
maxValue | double |
Возвращает или задает максимальное значение. |
|
decimalPlaces
|
decimalPlaces | integer |
Возвращает или задает десятичные разряды. |
|
disableThousandSeparator
|
disableThousandSeparator | boolean |
Возвращает или задает разделитель отключаемой тысячи. |
ContentValidationType
CreateAndInviteMembersResponse
Этот класс представляет возвращаемые параметры для API CreateAndInviteMembers.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
|
validationIssues
|
validationIssues | array of WritePanelMemberIssue |
Возвращает или задает проблемы. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
CreateArtifactResponse
Этот класс представляет ответ API CreateArtifact.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
CreateMembersResponse
Этот класс представляет возвращаемые параметры для API CreateMembers.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
membersIds
|
membersIds | array of integer |
Возвращает или задает идентификаторы элементов. |
|
validationIssues
|
validationIssues | array of WritePanelMemberIssue |
Возвращает или задает проблемы. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
CreatePanelResponse
Этот класс представляет возвращаемые параметры для API CreatePanel.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Получите идентификатор созданной панели. |
|
имя
|
name | string |
Получите имя созданной панели. |
|
isExtendedPanel
|
isExtendedPanel | boolean |
Получите тип созданной панели. |
|
дата создания
|
createdDate | string |
Получите дату создания созданной панели. |
|
isLock
|
isLock | boolean |
Получите значение, указывающее, является ли панель блокировкой. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
CreateSurveyResponse
Этот класс представляет возвращаемые параметры для API CreateSurvey.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
CreateWebHookResponse
Этот класс представляет возвращаемые параметры для API CreateWebHook.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
webHookId
|
webHookId | uuid |
Возвращает или задает идентификатор веб-перехватчика. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
CustomVariable
Этот класс представляет одну пользовательскую переменную.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
variableName
|
variableName | string |
Возвращает или задает имя переменной. |
|
variableType
|
variableType | VariableType |
VariableType |
DataAccessControl
Этот класс содержит конфигурацию доступности сущности.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
accessType
|
accessType | AccessType |
ТипДоступа |
|
условия
|
conditions | array of Condition |
Возвращает или задает условия. |
DeleteArtifactResponse
Этот класс представляет возвращаемые параметры для API DeleteArtifact.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
DeleteDistributorResponse
Этот класс представляет возвращаемые параметры для API DeleteDistributor.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
DeleteInterviewResponse
Этот класс представляет возвращаемые параметры для API DeleteInterview.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
DeleteMembersResponse
Этот класс представляет возвращаемые параметры для API DeleteMember.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
DeletePanelResponse
Этот класс представляет возвращаемые параметры для API DeleteSample.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
DeleteSamplingProjectResponse
Этот класс представляет возвращаемые параметры для API DeleteSamplingProject.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
DeleteSurveyResponse
Этот класс представляет возвращаемые параметры для API DeleteSurvey.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
DeleteWebHookResponse
Этот класс представляет возвращаемые параметры для API DeleteWebHook.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
DesignConfiguration
Этот класс представляет возможности стилизации для учетной записи.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
surveyDesignLayout
|
surveyDesignLayout | integer |
Возвращает или задает макет макета опроса. |
|
matrixSubQuestionSize
|
matrixSubQuestionSize | MatrixSubQuestionSize |
MatrixSubQuestionSize |
|
TextBlocks
|
textBlocks | array of TextBlock |
Возвращает или задает содержимое шаблона. |
DistributionChannel
Распространитель
Этот класс представляет элемент распространителя.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
|
distributionChannel
|
distributionChannel | DistributionChannel |
Канал распространения |
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
surveyVersion
|
surveyVersion | integer |
Возвращает или задает версию опроса. |
|
panelId
|
panelId | integer |
Возвращает или задает идентификатор панели. |
|
scheduledDistribution
|
scheduledDistribution | date-time |
Возвращает или задает запланированное распределение. |
|
выполнениеdistribution
|
executedDistribution | date-time |
Возвращает или задает исполняемый дистрибутив. |
|
distributionState
|
distributionState | string |
Возвращает или задает состояние распределения. |
|
условия
|
conditions | array of ConditionDefinition |
Возвращает или задает условия. |
DownloadAnswersResponse
Этот класс представляет возвращаемые параметры для API DownloadAnswers.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
скачатьUrl
|
downloadUrl | string |
Возвращает или задает URL-адрес скачивания. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ElementType
Тип события
ExecuteSendMailResponse
Этот класс представляет параметры возврата для API ExecuteSendMail.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ExecuteWorkflowTransitionResponse
Этот класс представляет возвращаемые параметры для API ExecuteWorkflowTransition.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ExecutionBehavior
Собеседование
Этот класс представляет данные записи интервью
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
Идентификатор интервью |
|
государство
|
state | string |
Возвращает или задает состояние. |
|
surveyId
|
surveyId | integer |
Идентификатор опроса |
|
surveyVersionId
|
surveyVersionId | integer |
Идентификатор версии опроса |
|
surveyName
|
surveyName | string |
Имя опроса |
|
surveyState
|
surveyState | string |
Возвращает или задает состояние опроса. |
|
answersLink
|
answersLink | string |
Ссылка на страницу печати ответов |
|
interviewLink
|
interviewLink | string |
Возвращает или задает ссылку на интервью. |
|
startDate
|
startDate | string |
Возвращает или задает дату начала. |
|
Дата окончания
|
endDate | string |
Возвращает или задает дату окончания. |
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
Пригласительный тип
InviteMembersResponse
Этот класс представляет возвращаемые параметры для API InviteMembers.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
идентификаторДистрибьютора
|
distributorId | integer |
Возвращает или задает идентификатор распространителя. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
MatrixSubQuestionSize
Член
Этот класс представляет собой один элемент панели с динамической структурой на основе панели.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
столбцов
|
fields | object |
Возвращает или задает поля. |
|
createdAt
|
createdAt | date-time |
Возвращает или задает созданный объект. |
|
создано кем
|
createdBy | string |
Возвращает или задает созданный объект. |
|
обновлено
|
updatedAt | date-time |
Возвращает или задает обновленное значение. |
|
обновленоBy
|
updatedBy | string |
Возвращает или задает обновленный. |
|
Интервью
|
interviews | array of Interview |
Возвращает или задает интервью. |
MessageTemplateItem
Этот класс представляет один элемент шаблона сообщения.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Идентификатор сообщения электронной почты |
|
имя
|
name | string |
Имя сообщения электронной почты |
|
содержимое
|
content | string |
Содержимое сообщения электронной почты |
|
субъект
|
subject | string |
Тема сообщения электронной почты |
|
defaultLocale
|
defaultLocale | string |
Языковой стандарт по умолчанию сообщения электронной почты |
|
Языков
|
locales | array of string |
Список языковых стандартов для этого сообщения электронной почты |
MinMaxChoice
Этот класс представляет элемент минимального максимального выбора внутри опроса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
код
|
code | string |
Возвращает или задает код. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
leftText
|
leftText | array of TranslationElement |
Возвращает или задает перевод текста слева. |
|
rightText
|
rightText | array of TranslationElement |
Возвращает или задает правильные переводы текста. |
|
excludeFromRandomization
|
excludeFromRandomization | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
condition
|
condition | ConditionDefinition |
Этот класс представляет определение элементов условий. |
OptOutItem
Этот класс представляет один элемент Opt-Out.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
электронная почта
|
string |
Возвращает или задает сообщение электронной почты. |
|
|
phone
|
phone | integer |
Возвращает или задает телефон. |
|
optOutAt
|
optOutAt | string |
Возвращает или задает отказ. |
|
optOutBy
|
optOutBy | string |
Возвращает или задает отказ. |
PanelDefinition
Этот класс содержит полное определение всех полей, содержащихся на определяемой клиентом панели.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
groups
|
groups | array of VariableGroupElement |
Возвращает или задает группы. |
|
dataAccessControl
|
dataAccessControl | DataAccessControl |
Этот класс содержит конфигурацию доступности сущности. |
PanelFieldItem
Этот класс представляет поле панели внутри панели.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
отображаемое имя
|
displayName | string |
Возвращает или задает отображаемое имя. |
|
isSystem
|
isSystem | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр системным. |
|
обязательный
|
mandatory | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.PanelFieldItem обязательным. |
|
анонимизация
|
anonymize | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.PanelFieldItem анонимным. |
|
validationExpression
|
validationExpression | string |
Возвращает или задает выражение проверки. |
|
validationErrorMessageId
|
validationErrorMessageId | string |
Возвращает или задает идентификатор сообщения проверки. |
|
panelFieldType
|
panelFieldType | VariableType |
VariableType |
|
metadata
|
metadata | object |
Возвращает или задает метаданные. |
PanelIncentive
Этот класс представляет собой один стимул.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
priceInCredits
|
priceInCredits | integer |
Возвращает или задает цену в кредитах. |
|
описание
|
description | string |
Возвращает или задает описание. |
|
availableVouchersCount
|
availableVouchersCount | integer |
Возвращает или задает количество доступных ваучеров. |
PanelSyncBehaviour
PanelSyncElement
Этот класс представляет один элемент синхронизации между опросом и панелью.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
идентификатор
|
identifier | string |
Возвращает или задает идентификатор. |
|
panelField
|
panelField | string |
Возвращает или задает поле панели. |
ReadArtifactListRequest
Этот класс представляет параметры запроса для API ReadArtifactList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
путь
|
path | string |
Возвращает или задает путь. |
|
workspaceId
|
workspaceId | integer |
Возвращает или задает идентификатор рабочей области. |
ReadBounceListResponseV3
Этот класс представляет возвращаемые параметры для API ReadBounceList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отказов
|
bounces | array of BounceElement |
Возвращает или задает список отказов. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadCreditBalanceResponse
Этот класс представляет параметры возврата для API ReadCreditBalance.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
равновесие
|
balance | integer |
Возвращает или задает баланс. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadDistributorListResponse
Этот класс представляет возвращаемые параметры для API ReadDistributorList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Дистрибьюторов
|
distributors | array of DistributorElement |
Возвращает или задает распространители. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadIncentiveListResponse
Этот класс представляет параметры запроса для API ReadIncentiveList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
panelIncentives
|
panelIncentives | array of PanelIncentive |
Возвращает или задает стимулы панели. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadIncentiveTransactionListResponse
Этот класс представляет возвращаемые параметры для API ReadIncentiveTransactionList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
incentiveTransactions
|
incentiveTransactions | array of SurveyCreditLog |
Возвращает или задает транзакции поощрения. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadInterviewDataResponse
Этот класс представляет возвращаемые параметры для API ReadInterviewData.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные ответа
|
responseData | object |
Возвращает или задает данные ответа. |
|
surveyDefinition
|
surveyDefinition | SurveyDefinition |
Этот класс представляет определение опроса, содержащего все метаданные и параметры. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadInterviewListCompactResponseV3
Этот класс представляет возвращаемые параметры для API ReadInterviewListCompact.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
surveyName
|
surveyName | string |
Возвращает или задает имя опроса. |
|
surveyDefaultLanguage
|
surveyDefaultLanguage | string |
Возвращает или задает язык опроса по умолчанию. |
|
surveyLanguages
|
surveyLanguages | array of string |
Возвращает или задает языки опроса. |
|
Интервью
|
interviews | array of object |
Возвращает или задает интервью. |
|
items
|
interviews | object | |
|
codePlan
|
codePlan | array of SurveyMetadataItem |
Возвращает или задает план кода. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadInterviewListResponseV3
Этот класс представляет возвращаемые параметры для API ReadInterviewList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
surveyName
|
surveyName | string |
Возвращает или задает имя опроса. |
|
surveyDefaultLanguage
|
surveyDefaultLanguage | string |
Возвращает или задает язык опроса по умолчанию. |
|
surveyLanguages
|
surveyLanguages | array of string |
Возвращает или задает языки опроса. |
|
codePlan
|
codePlan | array of SurveyMetadataItem |
Возвращает или задает план кода. |
|
Интервью
|
interviews | array of Row |
Возвращает или задает интервью. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadMemberListResponse
Этот класс представляет возвращаемые параметры для API ReadMemberList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
члены
|
members | array of Member |
Возвращает или задает элементы панели. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadMessageTemplateListResponse
Этот класс представляет возвращаемые параметры для API ReadMessageTemplateList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
messageTemplates
|
messageTemplates | array of MessageTemplateItem |
Возвращает или задает шаблоны сообщений. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadOptOutListResponseV3
Этот класс представляет параметры возврата для API ReadOptOutList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
optOutItems
|
optOutItems | array of OptOutItem |
Возвращает или задает элементы отказа. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadPanelDefinitionResponse
Этот класс представляет возвращаемые параметры для API ReadPanelDefinition.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
панель
|
panel | PanelDefinition |
Этот класс содержит полное определение всех полей, содержащихся на определяемой клиентом панели. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadSamplingProjectResponse
Этот класс представляет возвращаемые параметры для API ReadSamplingProject.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
выборкаProject
|
samplingProject | SamplingProjectElement |
Этот класс представляет проект выборки. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadSurveyLinksResponse
Этот класс представляет ответ API ReadSurveyLinks.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
анонимный список
|
anonymousList | array of SurveyLink |
Возвращает или задает анонимный список. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadSurveyListResponse
Этот класс представляет параметры ответа для API ReadSurveyList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Опросы
|
surveys | array of SurveyListItem |
Возвращает или задает опросы. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadSurveyResponse
Этот класс представляет возвращаемые параметры для API ReadSurveyDefinition.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
surveyName
|
surveyName | string |
Возвращает или задает имя опроса. |
|
surveyVersion
|
surveyVersion | integer |
Возвращает или задает версию опроса. |
|
surveyState
|
surveyState | string |
Возвращает или задает состояние опроса. |
|
createdAt
|
createdAt | string |
Возвращает или задает созданный объект. |
|
создано кем
|
createdBy | string |
Возвращает или задает созданный объект. |
|
обзор
|
survey | SurveyDefinition |
Этот класс представляет определение опроса, содержащего все метаданные и параметры. |
|
surveyConfiguration
|
surveyConfiguration | SurveyConfiguration |
Этот класс представляет конфигурацию опроса со всеми параметрами, которые пользователь может настроить. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadWebHookListResponse
Этот класс представляет возвращаемые параметры для API ReadWebHookList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
веб-перехватчики
|
webHooks | array of WebHookElement |
Возвращает или задает веб-перехватчики. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadWorkflowTransitionsResponse
Этот класс представляет возвращаемые параметры для API ReadWorkflowTransitions.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Переходы
|
transitions | array of WorkflowTransition |
Возвращает или задает переходы. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ReadWorkspaceListResponse
Этот класс представляет параметры запроса для API ReadWorkspaceList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
workspaces
|
workspaces | array of WorkspaceDto |
Возвращает или задает рабочие области. |
|
totalCount
|
totalCount | integer |
Возвращает или задает общее число. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
АктивироватьIncentiveCodeResponse
Этот класс представляет возвращаемые параметры для API RedeemIncentiveCode.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
код ваучера
|
voucherCode | string |
Возвращает или задает код ваучера. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
НапоминатьMembersResponse
Этот класс представляет параметры возврата для API RemindMembers.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
reminderId
|
reminderId | integer |
Возвращает или задает идентификатор напоминания. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ResetInterviewResponse
Этот класс представляет возвращаемые параметры для API ResetInterview.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
Строка
Этот класс представляет один элемент строки.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
columns
|
columns | array of ColItem |
Возвращает или задает столбцы. |
RowItem
Этот класс представляет ответ на опрос.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
Возвращает или задает идентификатор. |
|
value
|
value | string |
Возвращает или задает значение. |
ВыборкаProjectElement
Этот класс представляет проект выборки.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
выборкаProjectId
|
samplingProjectId | integer |
Возвращает или задает идентификатор проекта выборки. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
workspaceId
|
workspaceId | integer |
Возвращает или задает идентификатор рабочей области. |
|
surveyId
|
surveyId | integer |
Возвращает или задает идентификатор опроса. |
|
surveyVersion
|
surveyVersion | integer |
Возвращает или задает версию опроса. |
|
panelId
|
panelId | integer |
Возвращает или задает идентификатор панели. |
|
выборкаProviderId
|
samplingProviderId | integer |
Возвращает или задает идентификатор поставщика выборки. |
|
projectState
|
projectState | string |
Возвращает или задает состояние проекта. |
|
scheduledDistribution
|
scheduledDistribution | string |
Возвращает или задает запланированное распределение. |
|
выполнениеdistribution
|
executedDistribution | string |
Возвращает или задает исполняемый дистрибутив. |
|
условия
|
conditions | array of ConditionDefinition |
Возвращает или задает условия. |
ScriptType
Секция
Этот класс представляет раздел внутри опроса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
randomizePages
|
randomizePages | boolean |
Возвращает или задает значение, указывающее, [случайные страницы]. |
|
excludeFromRandomization
|
excludeFromRandomization | boolean |
Возвращает или задает значение, указывающее, следует ли [исключить из случайности]. |
|
азы
|
elements | array of SurveyElement |
Возвращает или задает элементы. |
|
condition
|
condition | ConditionDefinition |
Этот класс представляет определение элементов условий. |
SurveyConfiguration
Этот класс представляет конфигурацию опроса со всеми параметрами, которые пользователь может настроить.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
designConfiguration
|
designConfiguration | DesignConfiguration |
Этот класс представляет возможности стилизации для учетной записи. |
|
анонимизацияConfiguration
|
anonymizingConfiguration | AnonymizingConfiguration |
Этот класс содержит параметры анонимизации, которые можно применить к группе рабочих областей, рабочей области или отдельному опросу. |
SurveyCreditLog
Этот класс представляет одну кредитную транзакцию.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
oldValue
|
oldValue | string |
Возвращает или задает старое значение. |
|
newValue
|
newValue | string |
Возвращает или задает новое значение. |
|
описание
|
description | string |
Возвращает или задает описание. |
|
modifiedDate
|
modifiedDate | string |
Возвращает или задает измененную дату. |
|
modifiedBy
|
modifiedBy | string |
Возвращает или задает измененный параметр. |
|
responseId
|
responseId | uuid |
Возвращает или задает идентификатор ответа. |
|
interviewLink
|
interviewLink | string |
Возвращает или задает ссылку на интервью. |
SurveyDefinition
Этот класс представляет определение опроса, содержащего все метаданные и параметры.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
allowMultipleParticipation
|
allowMultipleParticipation | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить несколько участников]. |
|
allowNavigateBack
|
allowNavigateBack | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить возврат]. |
|
allowSaveProgress
|
allowSaveProgress | boolean |
Возвращает или задает значение, указывающее, разрешено ли [разрешить ход сохранения]. |
|
randomizeSections
|
randomizeSections | boolean |
Возвращает или задает значение, указывающее, [случайные разделы]. |
|
enableAutoScroll
|
enableAutoScroll | boolean |
Возвращает или задает значение, указывающее, включена ли [включить автоматическую прокрутку]. |
|
enableCodeAccess
|
enableCodeAccess | boolean |
Возвращает или задает значение, указывающее, включен ли [включить доступ к коду]. |
|
dataAccessControl
|
dataAccessControl | DataAccessControl |
Этот класс содержит конфигурацию доступности сущности. |
|
associatedPanels
|
associatedPanels | array of integer |
Возвращает или задает идентификатор панели. |
|
codeAccessMode
|
codeAccessMode | CodeAccessMode |
AuthenticationType |
|
enablePanelSync
|
enablePanelSync | boolean |
Возвращает или задает значение, указывающее, включена ли [синхронизация панели]. |
|
panelSyncBehaviour
|
panelSyncBehaviour | PanelSyncBehaviour |
PanelSyncBehaviour |
|
panelSyncs
|
panelSyncs | array of PanelSyncElement |
Возвращает или задает синхронизацию панели. |
|
Язык defaultLanguage
|
defaultLanguage | string |
Возвращает или задает язык по умолчанию. |
|
Дата окончания
|
endDate | date-time |
Возвращает или задает дату окончания. |
|
Языки
|
languages | array of string |
Возвращает или задает языки. |
|
сортовое железо
|
sections | array of Section |
Возвращает или задает разделы. |
|
customVariables
|
customVariables | array of CustomVariable |
Возвращает или задает пользовательские переменные. |
|
surveyEndText
|
surveyEndText | array of TranslationElement |
Возвращает или задает конечный текст опроса. |
|
defaultTextOverrides
|
defaultTextOverrides | object |
Возвращает или задает переопределение текста по умолчанию. |
SurveyElement
Этот класс представляет определение элемента опроса со всеми метаданными и параметрами.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
elementType
|
elementType | ElementType |
ElementType |
|
код
|
code | string |
Возвращает или задает код. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Возвращает или задает значение, указывающее, изменился ли [код вручную]. |
|
текст
|
text | array of TranslationElement |
Возвращает или задает переводы текста. |
|
hintText
|
hintText | array of TranslationElement |
Возвращает или задает переводы текста подсказки. |
|
hasHintText
|
hasHintText | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр текст подсказки. |
|
hasNotAvailableChoice
|
hasNotAvailableChoice | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр недоступный выбор. |
|
notAvailableChoiceText
|
notAvailableChoiceText | array of TranslationElement |
Возвращает или задает недоступные текстовые переводы выбора. |
|
forceResponse
|
forceResponse | boolean |
Возвращает или задает значение, указывающее, является ли [принудительный ответ]. |
|
choices
|
choices | array of Choice |
Возвращает или задает варианты. |
|
randomizeChoices
|
randomizeChoices | boolean |
Возвращает или задает значение, указывающее, является ли [случайный выбор]. |
|
columnType
|
columnType | ColumnType |
Тип столбца |
|
prompt
|
prompt | array of TranslationElement |
Возвращает или задает запрос. |
|
минимальное значение
|
minValue | integer |
Возвращает или задает минимальное значение. |
|
максимальное значение
|
maxValue | integer |
Возвращает или задает максимальное значение. |
|
showCenterLabel
|
showCenterLabel | boolean |
Возвращает или задает значение, указывающее, является ли [show center label]. |
|
leftLabel
|
leftLabel | array of TranslationElement |
Возвращает или задает левую метку. |
|
centerLabel
|
centerLabel | array of TranslationElement |
Возвращает или задает метку центра. |
|
rightLabel
|
rightLabel | array of TranslationElement |
Возвращает или задает правильную метку. |
|
showValue
|
showValue | boolean |
Возвращает или задает значение, указывающее, является ли [показать значение]. |
|
maxDecimals
|
maxDecimals | integer |
Возвращает или задает максимальные цифры после запятой. |
|
textFieldSize
|
textFieldSize | TextFieldSize |
TextFieldSize |
|
автозавершение
|
autocomplete | boolean |
Возвращает или задает значение, указывающее, является ли этот survalyzer.Contracts.Public.Elements.SurveyElement автоматически завершенным. |
|
autocompleteText
|
autocompleteText | array of TranslationElement |
Возвращает или задает автозавершение текстовых переводов. |
|
contentValidation
|
contentValidation | ContentValidation |
Этот класс представляет проверку содержимого внутри опроса. |
|
hasPlaceholder
|
hasPlaceholder | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр заполнитель. |
|
placeholder
|
placeholder | array of TranslationElement |
Возвращает или задает заполнитель. |
|
isPassword
|
isPassword | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр паролем. |
|
minMaxValidation
|
minMaxValidation | boolean |
Возвращает или задает значение, указывающее, является ли [минимальная максимальная проверка]. |
|
minimumCheckedChoices
|
minimumCheckedChoices | integer |
Возвращает или задает минимальные проверенные варианты. |
|
maximumCheckedChoices
|
maximumCheckedChoices | integer |
Возвращает или задает максимально проверенные варианты. |
|
columnGroups
|
columnGroups | array of ColumnGroup |
Возвращает или задает группы столбцов. |
|
randomizeRows
|
randomizeRows | boolean |
Возвращает или задает значение, указывающее, [случайные строки]. |
|
Строк
|
rows | array of MinMaxChoice |
Возвращает или задает строки. |
|
numberOfRanks
|
numberOfRanks | integer |
Возвращает или задает количество рангов. |
|
likeText
|
likeText | array of TranslationElement |
Возвращает или задает такие переводы текста. |
|
неприязнь к тексту
|
dislikeText | array of TranslationElement |
Получает или задает неприязнь к переводам текста. |
|
hasStartText
|
hasStartText | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр начальный текст. |
|
startText
|
startText | array of TranslationElement |
Возвращает или задает начальный текст. |
|
enableMeasurement
|
enableMeasurement | boolean |
Возвращает или задает значение, указывающее, включена ли [включить измерение]. |
|
showButtons
|
showButtons | boolean |
Возвращает или задает значение, указывающее, [показать кнопки]. |
|
likeKey
|
likeKey | string |
Возвращает или задает такой ключ. |
|
не нравитсяKey
|
dislikeKey | string |
Возвращает или задает нелюбовный ключ. |
|
interviewState
|
interviewState | string |
Возвращает или задает состояние ответа. |
|
действие
|
action | ActionElement |
Этот класс представляет собой конец действия опроса для полного завершения или завершения экрана или квоты. |
|
от / из / с (context-dependent)
|
from | string |
Возвращает или задает отправителя. |
|
Кому
|
to | string |
Возвращает или задает приемник. |
|
субъект
|
subject | array of TranslationElement |
Возвращает или задает переводы субъектов. |
|
сообщение
|
message | array of TranslationElement |
Возвращает или задает переводы сообщений. |
|
valueAssignmentType
|
valueAssignmentType | ValueAssignmentType |
ValueAssignmentType |
|
variableName
|
variableName | string |
Возвращает или задает имя переменной. |
|
functionTerm
|
functionTerm | array of TranslationElement |
Возвращает или задает термин функции. |
|
executionBehavior
|
executionBehavior | ExecutionBehavior |
ExecutionBehavior |
|
apiCallMethod
|
apiCallMethod | ApiCallMethod |
ApiCallMethod |
|
URL-адрес
|
url | array of TranslationElement |
Возвращает или задает URL-адрес. |
|
headers
|
headers | string |
Возвращает или задает заголовки. |
|
body
|
body | array of TranslationElement |
Возвращает или задает текст. |
|
externalUri
|
externalUri | string |
Возвращает или задает внешний универсальный код ресурса (URI). |
|
scriptType
|
scriptType | ScriptType |
ScriptType |
|
содержимое
|
content | string |
Возвращает или задает содержимое. |
|
hasRatingLabels
|
hasRatingLabels | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр метки оценки. |
|
leftRatingLabel
|
leftRatingLabel | array of TranslationElement |
Возвращает или задает левую метку оценки. |
|
rightRatingLabel
|
rightRatingLabel | array of TranslationElement |
Возвращает или задает правильную метку оценки. |
|
condition
|
condition | ConditionDefinition |
Этот класс представляет определение элементов условий. |
|
evaluateAsJson
|
evaluateAsJson | boolean |
Возвращает или задает значение, указывающее, вычисляется ли [как json]. |
|
autocompleteListVariable
|
autocompleteListVariable | string |
Возвращает или задает переменную списка автозаполнения. |
|
arrangementMode
|
arrangementMode | ArrangementMode |
ArrangementMode |
|
enableAnimation
|
enableAnimation | boolean |
Возвращает или задает значение, указывающее, включена ли [включить анимацию]. |
|
useSmiley
|
useSmiley | boolean |
Возвращает или задает значение, указывающее, используется ли [использовать смайлику]. |
|
hasPrompt
|
hasPrompt | boolean |
Возвращает или задает значение, указывающее, имеет ли этот экземпляр запрос. |
SurveyLink
Сущность SurveyLink
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес
|
url | string |
Возвращает или задает URL-адрес. |
|
isCustom
|
isCustom | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр пользовательским. |
|
language
|
language | string |
Возвращает или задает язык. |
SurveyListItem
Этот класс представляет один элемент опроса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Идентификатор опроса |
|
имя
|
name | string |
Имя опроса |
|
modifiedDate
|
modifiedDate | string |
Измененная дата опроса |
|
Дата окончания
|
endDate | string |
Дата окончания опроса |
|
isEndDateEnabled
|
isEndDateEnabled | boolean |
Если дата окончания включена для этого опроса |
|
статус
|
status | SurveyStatus |
SurveyStatus |
|
archiveDate
|
archiveDate | string |
Дата архивирования опроса |
|
statusOn
|
statusOn | boolean |
Опрос включен или отключен |
|
ответы
|
answers | integer |
Возвращает или задает ответы. |
SurveyMetadataItem
Этот класс представляет один элемент метаданных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
код
|
code | string |
Возвращает или задает код. |
|
тип данных
|
dataType | string |
Возвращает или задает тип данных. |
|
вопрос-код
|
questionCode | string |
Возвращает или задает код вопроса. |
|
type
|
type | string |
Возвращает или задает тип. |
|
вопрос
|
question | string |
Возвращает или задает вопрос. |
|
ряд
|
row | string |
Возвращает или задает строку. |
|
choice
|
choice | string |
Возвращает или задает выбор. |
|
values
|
values | array of RowItem |
Возвращает или задает значения. |
|
sectionName
|
sectionName | string |
Возвращает или задает имя раздела. |
SurveyStatus
текстовый блок
текстовый блок
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
Возвращает или задает имя. |
|
type
|
type | string |
Возвращает или задает тип. |
|
текст
|
text | array of TranslationElement |
Возвращает или задает текст. |
TextFieldSize
TranslationElement
Этот класс представляет перевод текста внутри опроса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
languageCode
|
languageCode | string |
Возвращает или задает языковой код. |
|
текст
|
text | string |
Возвращает или задает текст. |
UpdateMembersResponse
Этот класс представляет возвращаемые параметры для API UpdateMembers.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
validationIssues
|
validationIssues | array of WritePanelMemberIssue |
Возвращает или задает проблемы. |
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
UpdateSurveyResponse
Этот класс представляет возвращаемые параметры для API UpdateSurvey.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
UpdateWebHookResponse
Этот класс представляет возвращаемые параметры для API CreateWebHook.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
ValueAssignmentType
VariableGroupElement
Этот класс представляет группу полей на панели.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
отображаемое имя
|
displayName | string |
Возвращает или задает отображаемое имя. |
|
столбцов
|
fields | array of PanelFieldItem |
Возвращает или задает поля. |
VariableType
WebHookElement
Этот класс представляет один веб-перехватчик
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Возвращает или задает идентификатор. |
|
eventType
|
eventType | EventType |
Тип события |
|
entityIdentifier
|
entityIdentifier | string |
Возвращает или задает идентификатор сущности. |
|
createdAt
|
createdAt | date-time |
Возвращает или задает созданный объект. |
|
создано кем
|
createdBy | string |
Возвращает или задает созданный объект. |
|
обновлено
|
updatedAt | date-time |
Возвращает или задает обновленное значение. |
|
обновленоBy
|
updatedBy | string |
Возвращает или задает обновленный. |
WorkflowTransition
Этот класс представляет один переход от одного состояния к другому.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
Возвращает или задает имя. |
|
действие
|
action | string |
Возвращает или задает имя действия. |
|
newState
|
newState | string |
Создает новое состояние. |
|
condition
|
condition | string |
Возвращает или задает условие. |
WorkspaceDto
Этот класс представляет одну сущность рабочей области.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Возвращает или задает идентификатор. |
|
имя
|
name | string |
Возвращает или задает имя. |
|
numberOfSurveys
|
numberOfSurveys | integer |
Возвращает или задает количество опросов. |
WriteOptOutListResponse
Этот класс представляет возвращаемые параметры для API WriteOptOutList.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
WritePanelMemberIssue
Представляет некоторую проблему, которая может появиться
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
WritePanelResponse
Этот класс представляет возвращаемые параметры для API WritePanel.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
являетсяУспешным
|
isSuccess | boolean |
Возвращает или задает значение, указывающее, является ли этот экземпляр успешным. |
|
errorMessage
|
errorMessage | string |
Получает или устанавливает сообщение об ошибке. |
|
Код ошибки
|
errorCode | string |
Получает или задает код ошибки. |