Survalyzer EU (プレビュー)

  • リファレンス

Survalyzer コネクタを使用すると、EU のデータ センターのすべての API 機能へ簡単にアクセスできます。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Survalyzer 開発者センター
[URL] https://developer.survalyzer.com/
Connector Metadata
発行者 Survalyzer AG
Web サイト https://survalyzer.com
プライバシー ポリシー https://survalyzer.com/privacy-policy
カテゴリー マーケティング、生産性

接続を作成する

このコネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ Description Required
クライアント ID - 自分の Survalyzer ClientId string クライアント ID を入力してください。 True
クライアント シークレット - 自分の Survalyzer ClientSecret securestring クライアント シークレットを入力してください。 True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

Web hook を更新する

このアクションで、Web hook を更新することができます。
WebHook の作成

このアクションで、Web hook を作成できます。
Webhook を削除する

このアクションで、Web hook を削除できます。
WebHooks の読み取り

このアクションで、Web hook の一覧を読み取ることができます。
アンケートのリンクを読み取る

このアクションで、アンケートのリンクを読み取ることができます。
アンケートの更新

このアクションで、アンケートを更新することができます。
アンケートの読み取り

このアクションで、アンケートを読み取ることができます。
アンケートの読み取り

このアクションにより、指定したワークスペースの使用できるアンケートをすべて読み取ることができます。
アンケートを作成する

このアクションで、アンケートを作成できます。
アンケートを削除する

このアクションで、アンケートを削除できます。
アーティファクトを作成する

このアクションで、新しいアーティファクトを作成できます。
アーティファクトを削除する

このアクションで、アーティファクトを削除できます。
インセンティブ コードを引き換える

このアクションにより、調査クレジットをインセンティブ/伝票に使用できるようになります。
インセンティブ トランザクションを読み込む

このアクションにより、調査クレジットに関連するすべての収益と支出の概要が返されます。
インセンティブを読む

このアクションは、認証されたユーザーが使用できるインセンティブ/伝票を返します。
インタビュー PDF をダウンロード

このアクションで、回答をダウンロードできます。
インタビューの削除

このアクションで、インタビューを削除できます。
インタビューをリセット

このアクションで、パネル メンバーの応答をリセットすることができます。
インタビューを読む

このアクションで、インタビュー データを読み込むことができます。
インタビューを読む

このアクションで、インタビューの一覧を読み込むことができます。
オプトアウトの更新

このアクションにより、ワークスペースのオプトアウト一覧にエントリを書き込むことができるようになります。
オプトアウトの読み取り

このアクションにより、ワークスペースのすべてのオプトアウトを読み取ることができます。
クレジット残高を読み込む

このアクションは、認証されたユーザーの調査クレジット残高を返します。
コンパクトなインタビューを読み込む

このアクションで、インタビューの一覧コンパクトを読み込むことができます。
サンプリング プロジェクトを削除する

このアクションで、サンプリング プロジェクトを削除できます。
サンプリング プロジェクトを読み取る

このアクションで、サンプリング プロジェクトを読み取ることができます。
ディストリビューターの削除

このアクションで、ディストリビューターを削除できます。
ディストリビューターを読む

このアクションで、ディストリビューターの一覧を読み込むことができます。
バウンスを読む

このアクションで、バウンスの一覧を読み込むことができます。
パネルの削除

このアクションで、パネルを削除できます。
パネルの読み取り

このアクションで、パネル定義を読み取ることができます。
パネルまたはサンプルの作成

このアクションで、新しいパネルを作成できます。
パネルを更新する

このアクションで、パネルを更新することができます。
メッセージ テンプレートを読み取る

このアクションにより、メールと SMS 用に構成されたすべてのメッセージ テンプレートを受信できるようになります。
メンバーにリマインドする

このアクションで、メンバーをリマインドすることができます。
メンバーを作成

このアクションで、メンバーの一覧を作成できます。
メンバーを削除する

このアクションで、メンバーを削除できます。
メンバーを招待する

このアクションで、メンバーを招待することができます。
メンバーを招待する

このアクションで、メンバーを作成して招待することができます。
メンバーを更新する

このアクションで、メンバーの一覧を更新することができます。
メンバーを読み取る

このアクションで、メンバーを読み取ることができます。
ワーク フローの切り替えを読み取る

このアクションにより、ワークフローに固有のワークフローの切り替えをすべて読み取ることができるようになります。
ワークスペースの読み取り

このアクションにより、使用できるワークスペースをすべて読み取ることができます。
ワークフローの切り替えを実行する

このアクションにより、ワークフローに固有のワークフローの切り替えを実行できるようになります。
成果物を読む

このアクションで、成果物の一覧を読み込むことができます。
電子メールの送信

このアクションで、メールを送信することができます。

Web hook を更新する

操作 ID:
UpdateWebHook

このアクションで、Web hook を更新することができます。

パラメーター

名前 キー 必須 型 説明
webHookId
 webHookId uuid

Web hook 識別子を取得または設定します。
eventType
 eventType string

EventType
entityIdentifier
 entityIdentifier string

エンティティ識別子を取得または設定します。
securityToken
 securityToken string

セキュリティ トークンを取得または設定します。
webHookUrl
 webHookUrl string

Web hook URL を取得または設定します。

戻り値

このクラスは、CreateWebHook API の返却パラメーターを表します。

Body
UpdateWebHookResponse

WebHook の作成

操作 ID:
CreateWebHook

このアクションで、Web hook を作成できます。

パラメーター

名前 キー 必須 型 説明
eventType
 eventType string

EventType
entityIdentifier
 entityIdentifier string

エンティティ識別子を取得または設定します。
securityToken
 securityToken string

セキュリティ トークンを取得または設定します。
webHookUrl
 webHookUrl string

Web hook URL を取得または設定します。

戻り値

このクラスは、CreateWebHook API の返却パラメーターを表します。

Body
CreateWebHookResponse

Webhook を削除する

操作 ID:
DeleteWebHook

このアクションで、Web hook を削除できます。

パラメーター

名前 キー 必須 型 説明
webHookId
 webHookId uuid

Web hook 識別子を取得または設定します。

戻り値

このクラスは、DeleteWebHook API の返却パラメーターを表します。

Body
DeleteWebHookResponse

WebHooks の読み取り

操作 ID:
ReadWebHookList

このアクションで、Web hook の一覧を読み取ることができます。

パラメーター

名前 キー 必須 型 説明
eventType
 eventType string

EventType
entityIdentifier
 entityIdentifier string

エンティティ識別子を取得または設定します。

戻り値

このクラスは、ReadWebHookList API の返却パラメーターを表します。

Body
ReadWebHookListResponse

アンケートのリンクを読み取る

操作 ID:
ReadSurveyLinks

このアクションで、アンケートのリンクを読み取ることができます。

パラメーター

名前 キー 必須 型 説明
surveyId
 surveyId integer

アンケート識別子を取得または設定します。

戻り値

このクラスは、ReadSurveyLinks API の応答を表します。

Body
ReadSurveyLinksResponse

アンケートの更新

操作 ID:
UpdateSurvey

このアクションで、アンケートを更新することができます。

パラメーター

名前 キー 必須 型 説明
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

AccessType
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
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
 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
 code string

コードを取得または設定します。
codeManuallyChanged
 codeManuallyChanged boolean

[コードが手動で変更された] かどうかを示す値を取得または設定します。
languageCode
 languageCode True string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。
hasHintText
 hasHintText boolean

このインスタンスにヒント テキストがあるかどうかを示す値を取得または設定します。
hasNotAvailableChoice
 hasNotAvailableChoice boolean

このインスタンスに利用できない選択肢があるかどうかを示す値を取得または設定します。
forceResponse
 forceResponse boolean

[応答を強制する] かどうかを示す値を取得または設定します。
id
 id True integer

識別子の取得または設定。
code
 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

ContentValidation
earliestDate
 earliestDate string

最も古い日付を取得または設定します。
latestDate
 latestDate string

最新の日付を取得または設定します。
minValue
 minValue double

最小値を取得または設定します。
maxValue
 maxValue double

最大値を取得または設定します。
decimalPlaces
 decimalPlaces integer

小数点以下を取得または設定します。
disableThousandSeparator
 disableThousandSeparator boolean

無効にする桁の区切り記号を取得または設定します。
conditionAction
 conditionAction True string

FilterAction
autocompleteListVariable
 autocompleteListVariable string

オートコンプリート一覧の変数を取得または設定します。
randomizeChoices
 randomizeChoices boolean

[選択肢をランダム化する] かどうかを示す値を取得または設定します。
columnType
 columnType string

ColumnType
minValue
 minValue integer

最小値を取得または設定します。
maxValue
 maxValue integer

最大値を取得または設定します。
showCenterLabel
 showCenterLabel boolean

[中間レベルを表示する] かどうかを示す値を取得または設定します。
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
 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

いいね! キーを取得または設定します。
dislikeKey
 dislikeKey string

興味なしキーを取得または設定する。
interviewState
 interviewState string

応答の状態を取得または設定します。
actionType
 actionType True string

QuotaAction
送信元
 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

[JASON として評価する] かどうかを示す値を取得または設定します。
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 string

種類を取得または設定します。
languageCode
 languageCode True string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。
anonymizingMode
 anonymizingMode True string

AnonymizingMode
logIp
 logIp True boolean

[IP をログする] かどうかを示す値を取得または設定します。
logUserAgent
 logUserAgent True boolean

[ユーザー エージェントをログする] かどうかを示す値を取得または設定します。
logReferer
 logReferer True boolean

[参照をログする] かどうかを示す値を取得または設定します。

戻り値

このクラスは、UpdateSurvey API の返却パラメーターを表します。

Body
UpdateSurveyResponse

アンケートの読み取り

操作 ID:
ReadSurvey

このアクションで、アンケートを読み取ることができます。

パラメーター

名前 キー 必須 型 説明
テナント
 tenant string

タレントを取得または設定します。
surveyId
 surveyId True integer

アンケート識別子を取得または設定します。

戻り値

このクラスは、ReadSurveyDefinition API の返却パラメーターを表します。

Body
ReadSurveyResponse

アンケートの読み取り

操作 ID:
ReadSurveyList

このアクションにより、指定したワークスペースの使用できるアンケートをすべて読み取ることができます。

パラメーター

名前 キー 必須 型 説明
workspaceId
 workspaceId True integer

ワークスペース識別子を取得または設定します。
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadSurveyList API の応答パラメーターを表します。

Body
ReadSurveyListResponse

アンケートを作成する

操作 ID:
CreateSurvey

このアクションで、アンケートを作成できます。

パラメーター

名前 キー 必須 型 説明
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

AccessType
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
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
 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
 code string

コードを取得または設定します。
codeManuallyChanged
 codeManuallyChanged boolean

[コードが手動で変更された] かどうかを示す値を取得または設定します。
languageCode
 languageCode True string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。
hasHintText
 hasHintText boolean

このインスタンスにヒント テキストがあるかどうかを示す値を取得または設定します。
hasNotAvailableChoice
 hasNotAvailableChoice boolean

このインスタンスに利用できない選択肢があるかどうかを示す値を取得または設定します。
forceResponse
 forceResponse boolean

[応答を強制する] かどうかを示す値を取得または設定します。
id
 id True integer

識別子の取得または設定。
code
 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

ContentValidation
earliestDate
 earliestDate string

最も古い日付を取得または設定します。
latestDate
 latestDate string

最新の日付を取得または設定します。
minValue
 minValue double

最小値を取得または設定します。
maxValue
 maxValue double

最大値を取得または設定します。
decimalPlaces
 decimalPlaces integer

小数点以下を取得または設定します。
disableThousandSeparator
 disableThousandSeparator boolean

無効にする桁の区切り記号を取得または設定します。
conditionAction
 conditionAction True string

FilterAction
autocompleteListVariable
 autocompleteListVariable string

オートコンプリート一覧の変数を取得または設定します。
randomizeChoices
 randomizeChoices boolean

[選択肢をランダム化する] かどうかを示す値を取得または設定します。
columnType
 columnType string

ColumnType
minValue
 minValue integer

最小値を取得または設定します。
maxValue
 maxValue integer

最大値を取得または設定します。
showCenterLabel
 showCenterLabel boolean

[中間レベルを表示する] かどうかを示す値を取得または設定します。
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
 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

いいね! キーを取得または設定します。
dislikeKey
 dislikeKey string

興味なしキーを取得または設定する。
interviewState
 interviewState string

応答の状態を取得または設定します。
actionType
 actionType True string

QuotaAction
送信元
 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

[JASON として評価する] かどうかを示す値を取得または設定します。
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 string

種類を取得または設定します。
languageCode
 languageCode True string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。
anonymizingMode
 anonymizingMode True string

AnonymizingMode
logIp
 logIp True boolean

[IP をログする] かどうかを示す値を取得または設定します。
logUserAgent
 logUserAgent True boolean

[ユーザー エージェントをログする] かどうかを示す値を取得または設定します。
logReferer
 logReferer True boolean

[参照をログする] かどうかを示す値を取得または設定します。

戻り値

このクラスは、CreateSurvey API の返却パラメーターを表します。

Body
CreateSurveyResponse

アンケートを削除する

操作 ID:
DeleteSurvey

このアクションで、アンケートを削除できます。

パラメーター

名前 キー 必須 型 説明
surveyId
 surveyId True integer

アンケート識別子を取得または設定します。

戻り値

このクラスは、DeleteSurvey API の返却パラメーターを表します。

Body
DeleteSurveyResponse

アーティファクトを作成する

操作 ID:
CreateArtifact

このアクションで、新しいアーティファクトを作成できます。

パラメーター

名前 キー 必須 型 説明
workspaceId
 workspaceId integer

ワークスペース識別子を取得または設定します。
パス
 path string

パスを取得または設定します。

戻り値

このクラスは、CreateArtifact API の応答を表します。

Body
CreateArtifactResponse

アーティファクトを削除する

操作 ID:
DeleteArtifact

このアクションで、アーティファクトを削除できます。

パラメーター

名前 キー 必須 型 説明
パス
 path string

パスを取得または設定します。
ファイル名
 filename string

ファイル名を取得または設定します。
workspaceId
 workspaceId integer

ワークスペース識別子を取得または設定します。

戻り値

このクラスは、DeleteArtifact API の返却パラメーターを表します。

Body
DeleteArtifactResponse

インセンティブ コードを引き換える

操作 ID:
RedeemIncentiveCode

このアクションにより、調査クレジットをインセンティブ/伝票に使用できるようになります。

パラメーター

名前 キー 必須 型 説明
incentiveId
 incentiveId True integer

インセンティブ識別子を取得または設定します。

戻り値

このクラスは、RedeemIncentiveCode API の返却パラメーターを表します。

Body
RedeemIncentiveCodeResponse

インセンティブ トランザクションを読み込む

操作 ID:
ReadIncentiveTransactionList

このアクションにより、調査クレジットに関連するすべての収益と支出の概要が返されます。

パラメーター

名前 キー 必須 型 説明
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadIncentiveTransactionList API の返却パラメーターを表します。

Body
ReadIncentiveTransactionListResponse

インセンティブを読む

操作 ID:
ReadIncentiveList

このアクションは、認証されたユーザーが使用できるインセンティブ/伝票を返します。

パラメーター

名前 キー 必須 型 説明
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadIncentiveList API の要求パラメーターを表します。

Body
ReadIncentiveListResponse

インタビュー PDF をダウンロード

操作 ID:
DownloadInterviewPdf

このアクションで、回答をダウンロードできます。

パラメーター

名前 キー 必須 型 説明
テナント
 tenant True string

テナント。
SurveyId
 surveyId True integer

調査識別子。
InterviewId
 interviewId True uuid

インタビューの識別子。
完了した一部を表示する
 showPartialCompleted boolean

true に設定されている場合 [完了した一部を表示します]。
Locale
 locale string

ロケール。
Thmezone
 timeZone string

タイム ゾーン。
isCancellationRequested
 isCancellationRequested boolean
canBeCanceled
 canBeCanceled boolean
isInvalid
 isInvalid boolean
isClosed
 isClosed boolean

戻り値

このクラスは、DownloadAnswers API の返却パラメーターを表します。

Body
DownloadAnswersResponse

インタビューの削除

操作 ID:
DeleteInterview

このアクションで、インタビューを削除できます。

パラメーター

名前 キー 必須 型 説明
interviewId
 interviewId uuid

インタビュー識別子を取得または設定します。
surveyId
 surveyId integer

アンケート識別子を取得または設定します。

戻り値

このクラスは、DeleteInterview API の返却パラメーターを表します。

Body
DeleteInterviewResponse

インタビューをリセット

操作 ID:
ResetInterview

このアクションで、パネル メンバーの応答をリセットすることができます。

パラメーター

名前 キー 必須 型 説明
surveyId
 surveyId integer

アンケート識別子を取得または設定します。
interviewId
 interviewId uuid

インタビュー識別子を取得または設定します。

戻り値

このクラスは、ResetInterview API の返却パラメーターを表します。

Body
ResetInterviewResponse

インタビューを読む

操作 ID:
ReadInterview

このアクションで、インタビュー データを読み込むことができます。

パラメーター

名前 キー 必須 型 説明
テナント
 tenant True string

タレントを取得または設定します。
interviewId
 interviewId True uuid

インタビュー識別子を取得または設定します。
surveyId
 surveyId True integer

アンケート識別子を取得または設定します。
loadSurveyDefinition
 loadSurveyDefinition boolean

[アンケート定義を読み込む] かどうかを示す値を取得または設定します。

戻り値

このクラスは、ReadInterviewData API の返却パラメーターを表します。

Body
ReadInterviewDataResponse

インタビューを読む

操作 ID:
ReadInterviewList

このアクションで、インタビューの一覧を読み込むことができます。

パラメーター

名前 キー 必須 型 説明
テナント
 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 True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadInterviewList API の返却パラメーターを表します。

Body
ReadInterviewListResponseV3

オプトアウトの更新

操作 ID:
WriteOptOutList

このアクションにより、ワークスペースのオプトアウト一覧にエントリを書き込むことができるようになります。

パラメーター

名前 キー 必須 型 説明
workspaceId
 workspaceId integer

ワークスペース識別子を取得または設定します。
panelId
 panelId integer

パネル識別子を取得または設定します。
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。
メールアドレス
 email True string

メールを取得または設定します。
optOutOperation
 optOutOperation True string

OptOutOperation
cellPhone
 cellPhone True integer

携帯電話を取得または設定します。
optOutOperation
 optOutOperation True string

OptOutOperation

戻り値

このクラスは、WriteOptOutList API の返却パラメーターを表します。

Body
WriteOptOutListResponse

オプトアウトの読み取り

操作 ID:
ReadOptOutList

このアクションにより、ワークスペースのすべてのオプトアウトを読み取ることができます。

パラメーター

名前 キー 必須 型 説明
panelId
 panelId integer

パネル識別子を取得または設定します。
workspaceId
 workspaceId integer

ワークスペース識別子を取得または設定します。
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadOptOutList API の返却パラメーターを表します。

Body
ReadOptOutListResponseV3

クレジット残高を読み込む

操作 ID:
ReadCreditBalance

このアクションは、認証されたユーザーの調査クレジット残高を返します。

パラメーター

名前 キー 必須 型 説明
object

このクラスは、ReadCreditBalance API の要求パラメーターを表します。

戻り値

このクラスは、ReadCreditBalance API の返却パラメーターを表します。

Body
ReadCreditBalanceResponse

コンパクトなインタビューを読み込む

操作 ID:
ReadInterviewListCompact

このアクションで、インタビューの一覧コンパクトを読み込むことができます。

パラメーター

名前 キー 必須 型 説明
テナント
 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 True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadInterviewListCompact API の返却パラメーターを表します。

Body
ReadInterviewListCompactResponseV3

サンプリング プロジェクトを削除する

操作 ID:
DeleteSamplingProject

このアクションで、サンプリング プロジェクトを削除できます。

パラメーター

名前 キー 必須 型 説明
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
keepInterviews
 keepInterviews boolean

[インタビューを維持する] かどうかを示す値を取得または設定します。

戻り値

このクラスは、DeleteSamplingProject API の返却パラメーターを表します。

Body
DeleteSamplingProjectResponse

サンプリング プロジェクトを読み取る

操作 ID:
ReadSamplingProject

このアクションで、サンプリング プロジェクトを読み取ることができます。

パラメーター

名前 キー 必須 型 説明
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。

戻り値

このクラスは、ReadSamplingProject API の返却パラメーターを表します。

Body
ReadSamplingProjectResponse

ディストリビューターの削除

操作 ID:
DeleteDistributor

このアクションで、ディストリビューターを削除できます。

パラメーター

名前 キー 必須 型 説明
distributorId
 distributorId True integer

ディストリビューターの識別子を取得または設定します。
keepInterviews
 keepInterviews boolean

[インタビューを維持する] かどうかを示す値を取得または設定します。

戻り値

このクラスは、DeleteDistributor API の返却パラメーターを表します。

Body
DeleteDistributorResponse

ディストリビューターを読む

操作 ID:
ReadDistributorList

このアクションで、ディストリビューターの一覧を読み込むことができます。

パラメーター

名前 キー 必須 型 説明
surveyId
 surveyId integer

アンケート識別子を取得または設定します。
panelId
 panelId integer

パネル識別子を取得または設定します。
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadDistributorList API の返却パラメーターを表します。

Body
ReadDistributorListResponse

バウンスを読む

操作 ID:
ReadBounceList

このアクションで、バウンスの一覧を読み込むことができます。

パラメーター

名前 キー 必須 型 説明
surveyId
 surveyId True integer

アンケート識別子を取得または設定します。
panelId
 panelId integer

パネル識別子を取得または設定します。
ディストリビューター
 distributors array of integer

ディストリビューターを取得または設定します。
invitationType
 invitationType string

InvitationType
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadBounceList API の返却パラメーターを表します。

Body
ReadBounceListResponseV3

パネルの削除

操作 ID:
DeletePanel

このアクションで、パネルを削除できます。

パラメーター

名前 キー 必須 型 説明
panelId
 panelId True integer

サンプル識別子を取得または設定します。
keepInterviews
 keepInterviews boolean

[インタビューを維持する] かどうかを示す値を取得または設定します。

戻り値

このクラスは、DeleteSample API の返却パラメーターを表します。

Body
DeletePanelResponse

パネルの読み取り

操作 ID:
ReadPanel

このアクションで、パネル定義を読み取ることができます。

パラメーター

名前 キー 必須 型 説明
テナント
 tenant string

タレントを取得または設定します。
panelId
 panelId True integer

パネル識別子を取得または設定します。

戻り値

このクラスは、ReadPanelDefinition API の返却パラメーターを表します。

Body
ReadPanelDefinitionResponse

パネルまたはサンプルの作成

操作 ID:
CreatePanel

このアクションで、新しいパネルを作成できます。

パラメーター

名前 キー 必須 型 説明
workspaceId
 workspaceId True integer

ワークスペース識別子を取得または設定します。
名称
 name True string

パネル名を取得または設定します。
panelType
 panelType True string

PanelModelType

戻り値

このクラスは、CreatePanel API の返却パラメーターを表します。

Body
CreatePanelResponse

パネルを更新する

操作 ID:
UpdatePanel

このアクションで、パネルを更新することができます。

パラメーター

名前 キー 必須 型 説明
テナント
 tenant string

タレントを取得または設定します。
panelId
 panelId True integer

パネル識別子を取得または設定します。
id
 id integer

フィールドの ID。 名前を変更する場合、これは必須フィールドです。
名称
 name string

フィールドの名前。 これは必須フィールドです。
タイプ
 type string

PanelMemberFieldType
価値
 value

フィールドの値。 値のタイプはタイプ プロパティと一致する必要があります。
removedFields
 removedFields array of integer

削除したフィールドを取得または設定します。
id
 id integer

フィールドの ID。 名前を変更する場合、これは必須フィールドです。
名称
 name string

フィールドの名前。 これは必須フィールドです。
タイプ
 type string

PanelMemberFieldType
価値
 value

フィールドの値。 値のタイプはタイプ プロパティと一致する必要があります。

戻り値

このクラスは、WritePanel API の返却パラメーターを表します。

Body
WritePanelResponse

メッセージ テンプレートを読み取る

操作 ID:
ReadMessageTemplateList

このアクションにより、メールと 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 True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadMessageTemplateList API の返却パラメーターを表します。

Body
ReadMessageTemplateListResponse

メンバーにリマインドする

操作 ID:
RemindMembers

このアクションで、メンバーをリマインドすることができます。

パラメーター

名前 キー 必須 型 説明
distributorId
 distributorId True integer

アンケートの ID
messageTemplateId
 messageTemplateId True integer

メッセージ テンプレート識別子を取得または設定します。
名称
 name string

名前を取得または設定します。
タイプ
 type string

種類を取得または設定します。
languageCode
 languageCode True string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。
scheduleDateTime
 scheduleDateTime date-time

スケジュール時刻を取得または設定します。
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
channel
 channel string

作業配分チャネル
送信元
 from string

開始日を取得または設定します。
fromName
 fromName string

送信元名を取得または設定します。
replyTo
 replyTo string

返信先を取得または設定します。
replyToName
 replyToName string

返信先の名前を取得または設定します。

戻り値

このクラスは、RemindMembers API の返却パラメーターを表します。

Body
RemindMembersResponse

メンバーを作成

操作 ID:
CreateMembers

このアクションで、メンバーの一覧を作成できます。

パラメーター

名前 キー 必須 型 説明
テナント
 tenant string

タレントを取得または設定します。
panelId
 panelId True integer

パネル識別子を取得または設定します。
id
 id integer

識別子の取得または設定。
fields
 fields True object

フィールドを取得または設定します。
createdAt
 createdAt date-time

作成日時を取得または設定します。
createdBy
 createdBy string

作成者を取得または設定します。
updatedAt
 updatedAt date-time

更新日時を取得または設定します。
updatedBy
 updatedBy string

更新者を取得または設定します。
id
 id string

インタビューの ID
州
 state string

状態を取得または設定します。
surveyId
 surveyId integer

調査の ID
surveyVersionId
 surveyVersionId integer

アンケート バージョンの ID
surveyName
 surveyName string

アンケートの名前
surveyState
 surveyState string

アンケートの状態を取得または設定します。
answersLink
 answersLink string

回答印刷ページへのリンク
interviewLink
 interviewLink string

インタビュー リンクを取得または設定します。
startDate
 startDate string

開始日を取得または設定します。
endDate
 endDate string

終了日を取得または設定します。
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。

戻り値

このクラスは、CreateMembers API の返却パラメーターを表します。

Body
CreateMembersResponse

メンバーを削除する

操作 ID:
DeleteMembers

このアクションで、メンバーを削除できます。

パラメーター

名前 キー 必須 型 説明
panelId
 panelId True integer

パネル識別子を取得または設定します。
panelMembersIds
 panelMembersIds True array of integer

メンバー識別子を取得または設定します。
keepInterviews
 keepInterviews boolean

[インタビューを維持する] かどうかを示す値を取得または設定します。

戻り値

このクラスは、DeleteMember API の返却パラメーターを表します。

Body
DeleteMembersResponse

メンバーを招待する

操作 ID:
InviteMembers

このアクションで、メンバーを招待することができます。

パラメーター

名前 キー 必須 型 説明
surveyId
 surveyId True integer

アンケートの ID
panelId
 panelId True integer

パネル識別子を取得または設定します。
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
memberIds
 memberIds array of integer

パネル メンバー ID を取得または設定します。
messageTemplateId
 messageTemplateId True integer

メッセージ テンプレート識別子を取得または設定します。
名称
 name string

名前を取得または設定します。
タイプ
 type string

種類を取得または設定します。
languageCode
 languageCode True string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。
scheduleDateTime
 scheduleDateTime date-time

スケジュール時刻を取得または設定します。
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
channel
 channel string

作業配分チャネル
asyncProcess
 asyncProcess boolean

非同期プロセスを取得または設定します。
interviewExpiryDate
 interviewExpiryDate string

インタビューの有効期限日を取得または設定します。
送信元
 from string

開始日を取得または設定します。
fromName
 fromName string

送信元名を取得または設定します。
replyTo
 replyTo string

返信先を取得または設定します。
replyToName
 replyToName string

返信先の名前を取得または設定します。

戻り値

このクラスは、InviteMembers API の返却パラメーターを表します。

Body
InviteMembersResponse

メンバーを招待する

操作 ID:
CreateAndInviteMembers

このアクションで、メンバーを作成して招待することができます。

パラメーター

名前 キー 必須 型 説明
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
surveyId
 surveyId True integer

アンケート識別子を取得または設定します。
panelId
 panelId True integer

パネル識別子を取得または設定します。
channel
 channel True string

作業配分チャネル
messageTemplateId
 messageTemplateId True integer

メッセージ テンプレート識別子を取得または設定します。
名称
 name string

名前を取得または設定します。
タイプ
 type string

種類を取得または設定します。
languageCode
 languageCode True string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。
id
 id integer

識別子の取得または設定。
fields
 fields True object

フィールドを取得または設定します。
createdAt
 createdAt date-time

作成日時を取得または設定します。
createdBy
 createdBy string

作成者を取得または設定します。
updatedAt
 updatedAt date-time

更新日時を取得または設定します。
updatedBy
 updatedBy string

更新者を取得または設定します。
id
 id string

インタビューの ID
州
 state string

状態を取得または設定します。
surveyId
 surveyId integer

調査の ID
surveyVersionId
 surveyVersionId integer

アンケート バージョンの ID
surveyName
 surveyName string

アンケートの名前
surveyState
 surveyState string

アンケートの状態を取得または設定します。
answersLink
 answersLink string

回答印刷ページへのリンク
interviewLink
 interviewLink string

インタビュー リンクを取得または設定します。
startDate
 startDate string

開始日を取得または設定します。
endDate
 endDate string

終了日を取得または設定します。
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。
scheduleDateTime
 scheduleDateTime string

スケジュール日時を取得または設定します。
asyncProcess
 asyncProcess boolean

非同期プロセスを取得または設定します。
interviewExpiryDate
 interviewExpiryDate string

インタビューの有効期限日を取得または設定します。
送信元
 from string

開始日を取得または設定します。
fromName
 fromName string

送信元名を取得または設定します。
replyTo
 replyTo string

返信先を取得または設定します。
replyToName
 replyToName string

返信先の名前を取得または設定します。

戻り値

このクラスは、CreateAndInviteMembers API の返却パラメーターを表します。

Body
CreateAndInviteMembersResponse

メンバーを更新する

操作 ID:
UpdateMembers

このアクションで、メンバーの一覧を更新することができます。

パラメーター

名前 キー 必須 型 説明
テナント
 tenant string

タレントを取得または設定します。
panelId
 panelId True integer

パネル識別子を取得または設定します。
id
 id integer

識別子の取得または設定。
fields
 fields True object

フィールドを取得または設定します。
createdAt
 createdAt date-time

作成日時を取得または設定します。
createdBy
 createdBy string

作成者を取得または設定します。
updatedAt
 updatedAt date-time

更新日時を取得または設定します。
updatedBy
 updatedBy string

更新者を取得または設定します。
id
 id string

インタビューの ID
州
 state string

状態を取得または設定します。
surveyId
 surveyId integer

調査の ID
surveyVersionId
 surveyVersionId integer

アンケート バージョンの ID
surveyName
 surveyName string

アンケートの名前
surveyState
 surveyState string

アンケートの状態を取得または設定します。
answersLink
 answersLink string

回答印刷ページへのリンク
interviewLink
 interviewLink string

インタビュー リンクを取得または設定します。
startDate
 startDate string

開始日を取得または設定します。
endDate
 endDate string

終了日を取得または設定します。
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。

戻り値

このクラスは、UpdateMembers API の返却パラメーターを表します。

Body
UpdateMembersResponse

メンバーを読み取る

操作 ID:
ReadMemberList

このアクションで、メンバーを読み取ることができます。

パラメーター

名前 キー 必須 型 説明
テナント
 tenant string

タレントを取得または設定します。
panelId
 panelId True integer

パネル識別子を取得または設定します。
interviewsRequired
 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 True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadMemberList API の返却パラメーターを表します。

Body
ReadMemberListResponse

ワーク フローの切り替えを読み取る

操作 ID:
ReadWorkflowTransitions

このアクションにより、ワークフローに固有のワークフローの切り替えをすべて読み取ることができるようになります。

パラメーター

名前 キー 必須 型 説明
ワークフロー
 workflow True string

ワークフローの種類
currentState
 currentState True string

現在の状態を取得または設定します。

戻り値

このクラスは、ReadWorkflowTransitions API の返却パラメーターを表します。

Body
ReadWorkflowTransitionsResponse

ワークスペースの読み取り

操作 ID:
ReadWorkspaceList

このアクションにより、使用できるワークスペースをすべて読み取ることができます。

パラメーター

名前 キー 必須 型 説明
連動
 conjunction True string

連動
conditionType
 conditionType True string

ConditionType
識別子
 identifier True string

識別子の取得または設定。
conditionOperator
 conditionOperator True string

ConditionOperator
価値
 value True string

値を取得または設定します。
variableType
 variableType string

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。
pageSize
 pageSize True integer

ページのサイズを取得または設定します。
page
 page True integer

ページを取得または設定します。
orderField
 orderField string

注文フィールドを取得または設定します。
orderDirection
 orderDirection string

OrderDirection

戻り値

このクラスは、ReadWorkspaceList API の要求パラメーターを表します。

Body
ReadWorkspaceListResponse

ワークフローの切り替えを実行する

操作 ID:
ExecuteWorkflowTransition

このアクションにより、ワークフローに固有のワークフローの切り替えを実行できるようになります。

パラメーター

名前 キー 必須 型 説明
ワークフロー
 workflow True string

ワークフローの種類
surveyId
 surveyId integer

アンケート識別子を取得または設定します。
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。
reminderId
 reminderId integer

リマインダー識別子を取得または設定します。
targetState
 targetState True string

ターゲットの状態を取得または設定します。
dynamicParameters
 dynamicParameters object

ダイナミック パラメーターを取得または設定します。

戻り値

このクラスは、ExecuteWorkflowTransition API の返却パラメーターを表します。

Body
ExecuteWorkflowTransitionResponse

成果物を読む

操作 ID:
ReadArtifactList

このアクションで、成果物の一覧を読み込むことができます。

パラメーター

名前 キー 必須 型 説明
パス
 path string

パスを取得または設定します。
workspaceId
 workspaceId integer

ワークスペース識別子を取得または設定します。

戻り値

このクラスは、ReadArtifactList API の要求パラメーターを表します。

Body
ReadArtifactListRequest

電子メールの送信

操作 ID:
ExecuteSendMail

このアクションで、メールを送信することができます。

パラメーター

名前 キー 必須 型 説明
messageTemplateId
 messageTemplateId integer

メッセージ テンプレート識別子を取得または設定します。
名称
 name string

名前を取得または設定します。
タイプ
 type string

種類を取得または設定します。
languageCode
 languageCode True string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。
language
 language True string

言語を取得または設定します。
subject
 subject string

件名を取得または設定します。
body
 body string

本文を取得または設定します。
送信元
 from True string

開始日を取得または設定します。
fromName
 fromName string

送信元名を取得または設定します。
送信先
 to True string

設定先を取得または設定します。
toName
 toName string

名前に変換します。
replyTo
 replyTo string

返信先を取得または設定します。
replyToName
 replyToName string

返信先の名前を取得または設定します。

戻り値

このクラスは、ExecuteSendMail API の返却パラメーターを表します。

Body
ExecuteSendMailResponse

定義

AccessType

AccessType

AccessType

string

ActionElement

このクラスは、完了/スクリーンアウト/クォータの調査アクションの終了を表します。

名前 パス 型 説明
actionType
 actionType ActionType

QuotaAction
endOfSurveyText
 endOfSurveyText array of TranslationElement

アンケートのテキストの最後を取得または設定します。
forwardUrl
 forwardUrl array of TranslationElement

転送 URL を取得または設定します。

ActionType

QuotaAction

QuotaAction

string

AnonymizingConfiguration

このクラスには、ワークスペース グループ、ワークスペース、または個々のアンケートに適用できる匿名化設定が含まれています。

名前 パス 型 説明
anonymizingMode
 anonymizingMode AnonymizingMode

AnonymizingMode
logIp
 logIp boolean

[IP をログする] かどうかを示す値を取得または設定します。
logUserAgent
 logUserAgent boolean

[ユーザー エージェントをログする] かどうかを示す値を取得または設定します。
logReferer
 logReferer boolean

[参照をログする] かどうかを示す値を取得または設定します。

AnonymizingMode

AnonymizingMode

AnonymizingMode

string

ApiCallMethod

ApiCallMethod

ApiCallMethod

string

ArrangementMode

ArrangementMode

ArrangementMode

string

BounceElement

このクラスは、完了/スクリーンアウト/クォータの調査アクションの終了を表します。

名前 パス 型 説明
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。
interviewId
 interviewId uuid

インタビュー識別子を取得または設定します。
panelId
 panelId integer

パネル識別子を取得または設定します。
panelMemberId
 panelMemberId integer

メンバー識別子を取得または設定します。
bounceType
 bounceType BounceType

BounceType
timestamp
 timestamp date-time

タイムスタンプを取得または設定します。
州
 state string

状態を取得または設定します。
reason
 reason string

理由を取得または設定します。
メールアドレス
 email string

メールを取得または設定します。
電話番号
 phone integer

電話を取得または設定します。
invitationType
 invitationType InvitationType

InvitationType

BounceType

BounceType

BounceType

string

選択肢

このクラスは、あらゆる選択質問タイプで使用できる単一の選択肢を表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
code
 code string

コードを取得または設定します。
codeManuallyChanged
 codeManuallyChanged boolean

[コードが手動で変更された] かどうかを示す値を取得または設定します。
text
 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 ConditionDefinition

このクラスは条件要素の定義を表します。
autocompleteListVariable
 autocompleteListVariable string

オートコンプリート一覧の変数を取得または設定します。

ChoiceType

ChoiceType

ChoiceType

string

CodeAccessMode

AuthenticationType

AuthenticationType

string

ColItem

このクラスは、アンケート回答のセルを表します。

名前 パス 型 説明
id
 id string

識別子の取得または設定。
価値
 value

値を取得または設定します。

ColumnGroup

このクラスは、マトリックス質問などの複雑な質問タイプ内の列グループを表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
text
 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 ConditionDefinition

このクラスは条件要素の定義を表します。

ColumnType

ColumnType

ColumnType

string

状態

このクラスは、すべての条件要素の基盤です。

名前 パス 型 説明
連動
 conjunction Conjunction

連動
conditionType
 conditionType ConditionType

ConditionType
識別子
 identifier string

識別子の取得または設定。
conditionOperator
 conditionOperator ConditionOperator

ConditionOperator
価値
 value string

値を取得または設定します。
variableType
 variableType VariableType

VariableType
jsonValue
 jsonValue boolean

[JASON の値] かどうかを示す値を取得または設定します。
jsonPath
 jsonPath string

JASON パスを取得または設定します。

ConditionAction

FilterAction

FilterAction

string

ConditionDefinition

このクラスは条件要素の定義を表します。

名前 パス 型 説明
conditionAction
 conditionAction ConditionAction

FilterAction
要素
 elements array of Condition

要素を取得または設定します。

ConditionOperator

ConditionOperator

ConditionOperator

string

ConditionType

ConditionType

ConditionType

string

連動

連動

連動

string

ContentValidation

このクラスは、アンケート内のコンテンツ検証を表します。

名前 パス 型 説明
validationType
 validationType ContentValidationType

ContentValidation
earliestDate
 earliestDate string

最も古い日付を取得または設定します。
latestDate
 latestDate string

最新の日付を取得または設定します。
minValue
 minValue double

最小値を取得または設定します。
maxValue
 maxValue double

最大値を取得または設定します。
decimalPlaces
 decimalPlaces integer

小数点以下を取得または設定します。
disableThousandSeparator
 disableThousandSeparator boolean

無効にする桁の区切り記号を取得または設定します。

ContentValidationType

ContentValidation

ContentValidation

string

CreateAndInviteMembersResponse

このクラスは、CreateAndInviteMembers API の返却パラメーターを表します。

名前 パス 型 説明
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。
validationIssues
 validationIssues array of WritePanelMemberIssue

問題を取得または設定する。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

CreateArtifactResponse

このクラスは、CreateArtifact API の応答を表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

CreateMembersResponse

このクラスは、CreateMembers API の返却パラメーターを表します。

名前 パス 型 説明
membersIds
 membersIds array of integer

メンバー ID を取得または設定します。
validationIssues
 validationIssues array of WritePanelMemberIssue

問題を取得または設定する。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

CreatePanelResponse

このクラスは、CreatePanel API の返却パラメーターを表します。

名前 パス 型 説明
id
 id integer

作成されたパネルの ID を取得します。
名称
 name string

作成されたパネルの名前を取得します。
isExtendedPanel
 isExtendedPanel boolean

作成されたパネルの種類を取得します。
createdDate
 createdDate string

作成したパネルの作成日を取得します。
isLock
 isLock boolean

パネルがロックされているかどうかを示す値を取得します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

CreateSurveyResponse

このクラスは、CreateSurvey API の返却パラメーターを表します。

名前 パス 型 説明
surveyId
 surveyId integer

アンケート識別子を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

CreateWebHookResponse

このクラスは、CreateWebHook API の返却パラメーターを表します。

名前 パス 型 説明
webHookId
 webHookId uuid

Web hook 識別子を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

CustomVariable

このクラスは、単一のカスタム変数を表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
variableName
 variableName string

変数の名前を取得または設定します。
variableType
 variableType VariableType

VariableType

DataAccessControl

このクラスには、エンティティにアクセスするための構成が含まれています

名前 パス 型 説明
accessType
 accessType AccessType

AccessType
conditions
 conditions array of Condition

条件を取得または設定します。

DeleteArtifactResponse

このクラスは、DeleteArtifact API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

DeleteDistributorResponse

このクラスは、DeleteDistributor API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

DeleteInterviewResponse

このクラスは、DeleteInterview API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

DeleteMembersResponse

このクラスは、DeleteMember API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

DeletePanelResponse

このクラスは、DeleteSample API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

DeleteSamplingProjectResponse

このクラスは、DeleteSamplingProject API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

DeleteSurveyResponse

このクラスは、DeleteSurvey API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

DeleteWebHookResponse

このクラスは、DeleteWebHook API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

DesignConfiguration

このクラスは、アカウントのスタイル設定の可能性を表します。

名前 パス 型 説明
surveyDesignLayout
 surveyDesignLayout integer

アンケートのデザイン レイアウトを取得または設定します。
matrixSubQuestionSize
 matrixSubQuestionSize MatrixSubQuestionSize

MatrixSubQuestionSize
textBlocks
 textBlocks array of TextBlock

テンプレートのコンテンツを取得または設定します。

DistributionChannel

作業配分チャネル

作業配分チャネル

string

DistributorElement

このクラスはディストリビュータ要素を表します。

名前 パス 型 説明
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。
distributionChannel
 distributionChannel DistributionChannel

作業配分チャネル
surveyId
 surveyId integer

アンケート識別子を取得または設定します。
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
surveyVersion
 surveyVersion integer

アンケート バージョンを取得または設定します。
panelId
 panelId integer

パネル識別子を取得または設定します。
scheduledDistribution
 scheduledDistribution date-time

スケジュールされた配分を取得または設定します。
executedDistribution
 executedDistribution date-time

実行された配分を取得または設定します。
distributionState
 distributionState string

配分の状態を取得または設定します。
conditions
 conditions array of ConditionDefinition

条件を取得または設定します。

DownloadAnswersResponse

このクラスは、DownloadAnswers API の返却パラメーターを表します。

名前 パス 型 説明
downloadUrl
 downloadUrl string

ダウンロード URL コンテンツを取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ElementType

ElementType

ElementType

string

EventType

EventType

EventType

string

ExecuteSendMailResponse

このクラスは、ExecuteSendMail API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ExecuteWorkflowTransitionResponse

このクラスは、ExecuteWorkflowTransition API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ExecutionBehavior

ExecutionBehavior

ExecutionBehavior

string

面談

このクラスはインタビューの記録データを表します

名前 パス 型 説明
id
 id string

インタビューの ID
州
 state string

状態を取得または設定します。
surveyId
 surveyId integer

調査の ID
surveyVersionId
 surveyVersionId integer

アンケート バージョンの ID
surveyName
 surveyName string

アンケートの名前
surveyState
 surveyState string

アンケートの状態を取得または設定します。
answersLink
 answersLink string

回答印刷ページへのリンク
interviewLink
 interviewLink string

インタビュー リンクを取得または設定します。
startDate
 startDate string

開始日を取得または設定します。
endDate
 endDate string

終了日を取得または設定します。
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。

InvitationType

InvitationType

InvitationType

string

InviteMembersResponse

このクラスは、InviteMembers API の返却パラメーターを表します。

名前 パス 型 説明
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
distributorId
 distributorId integer

ディストリビューターの識別子を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

MatrixSubQuestionSize

MatrixSubQuestionSize

MatrixSubQuestionSize

string

Member

このクラスは、パネルに基づく動的構造を持つ単一のパネル メンバーを表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
fields
 fields object

フィールドを取得または設定します。
createdAt
 createdAt date-time

作成日時を取得または設定します。
createdBy
 createdBy string

作成者を取得または設定します。
updatedAt
 updatedAt date-time

更新日時を取得または設定します。
updatedBy
 updatedBy string

更新者を取得または設定します。
面接
 interviews array of Interview

インタビューを取得または設定します。

MessageTemplateItem

このクラスは 1 つのメッセージ テンプレート項目を表します。

名前 パス 型 説明
id
 id integer

メール メッセージの ID
名称
 name string

メール メッセージの名前
コンテント
 content string

メール メッセージの内容
subject
 subject string

メール メッセージの件名です
defaultLocale
 defaultLocale string

メール メッセージの既定のロケ―ル
ロケール
 locales array of string

このメール メッセージのロケール一覧

MinMaxChoice

このクラスは、アンケート内の最小最大選択要素を表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
code
 code string

コードを取得または設定します。
codeManuallyChanged
 codeManuallyChanged boolean

[コードが手動で変更された] かどうかを示す値を取得または設定します。
leftText
 leftText array of TranslationElement

左のテキスト翻訳を取得または設定します。
rightText
 rightText array of TranslationElement

右のテキスト翻訳を取得または設定します。
excludeFromRandomization
 excludeFromRandomization boolean

[ランダム化から除外する] かどうかを示す値を取得または設定します。
条件
 condition ConditionDefinition

このクラスは条件要素の定義を表します。

OptOutItem

このクラスは 1 つのオプトアウト項目を表します。

名前 パス 型 説明
メールアドレス
 email string

メールを取得または設定します。
電話番号
 phone integer

電話を取得または設定します。
optOutAt
 optOutAt string

オプトアウト場所を取得または設定します。
optOutBy
 optOutBy string

オプトアウト者を取得または設定します。

PanelDefinition

このクラスには、顧客定義のパネルに含まれるすべてのフィールドの完全な定義が含まれています。

名前 パス 型 説明
groups
 groups array of VariableGroupElement

グループを取得または設定します。
dataAccessControl
 dataAccessControl DataAccessControl

このクラスには、エンティティにアクセスするための構成が含まれています

PanelFieldItem

このクラスは、パネル内のパネル フィールドを表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
名称
 name string

名前を取得または設定します。
displayName
 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
 description string

説明を取得または設定します。
availableVouchersCount
 availableVouchersCount integer

使用できる伝票数を取得または設定します。

PanelSyncBehaviour

PanelSyncBehaviour

PanelSyncBehaviour

string

PanelSyncElement

このクラスは、アンケートとパネル間の単一の同期項目を表します。

名前 パス 型 説明
識別子
 identifier string

識別子の取得または設定。
panelField
 panelField string

パネル フィールドを取得または設定します。

ReadArtifactListRequest

このクラスは、ReadArtifactList API の要求パラメーターを表します。

名前 パス 型 説明
パス
 path string

パスを取得または設定します。
workspaceId
 workspaceId integer

ワークスペース識別子を取得または設定します。

ReadBounceListResponseV3

このクラスは、ReadBounceList API の返却パラメーターを表します。

名前 パス 型 説明
バウンス
 bounces array of BounceElement

バウンスの一覧を取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadCreditBalanceResponse

このクラスは、ReadCreditBalance API の返却パラメーターを表します。

名前 パス 型 説明
残高
 balance integer

残高を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadDistributorListResponse

このクラスは、ReadDistributorList API の返却パラメーターを表します。

名前 パス 型 説明
ディストリビューター
 distributors array of DistributorElement

ディストリビューターを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadIncentiveListResponse

このクラスは、ReadIncentiveList API の要求パラメーターを表します。

名前 パス 型 説明
panelIncentives
 panelIncentives array of PanelIncentive

パネル インセンティブを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadIncentiveTransactionListResponse

このクラスは、ReadIncentiveTransactionList API の返却パラメーターを表します。

名前 パス 型 説明
incentiveTransactions
 incentiveTransactions array of SurveyCreditLog

インセンティブ トランザクションを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadInterviewDataResponse

このクラスは、ReadInterviewData API の返却パラメーターを表します。

名前 パス 型 説明
responseData
 responseData object

応答データを取得または設定します。
surveyDefinition
 surveyDefinition SurveyDefinition

このクラスは、すべてのメタデータと設定を含む調査の定義を表します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadInterviewListCompactResponseV3

このクラスは、ReadInterviewListCompact API の返却パラメーターを表します。

名前 パス 型 説明
surveyName
 surveyName string

アンケートの名前を取得または設定します。
surveyDefaultLanguage
 surveyDefaultLanguage string

アンケートの既定言語を取得または設定します。
surveyLanguages
 surveyLanguages array of string

アンケート言語を取得または設定します。
面接
 interviews array of object

インタビューを取得または設定します。
アイテム
 interviews object
codePlan
 codePlan array of SurveyMetadataItem

コード プランを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadInterviewListResponseV3

このクラスは、ReadInterviewList API の返却パラメーターを表します。

名前 パス 型 説明
surveyName
 surveyName string

アンケートの名前を取得または設定します。
surveyDefaultLanguage
 surveyDefaultLanguage string

アンケートの既定言語を取得または設定します。
surveyLanguages
 surveyLanguages array of string

アンケート言語を取得または設定します。
codePlan
 codePlan array of SurveyMetadataItem

コード プランを取得または設定します。
面接
 interviews array of Row

インタビューを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadMemberListResponse

このクラスは、ReadMemberList API の返却パラメーターを表します。

名前 パス 型 説明
members
 members array of Member

パネル メンバーを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadMessageTemplateListResponse

このクラスは、ReadMessageTemplateList API の返却パラメーターを表します。

名前 パス 型 説明
messageTemplates
 messageTemplates array of MessageTemplateItem

メッセージ テンプレートを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadOptOutListResponseV3

このクラスは、ReadOptOutList API の返却パラメーターを表します。

名前 パス 型 説明
optOutItems
 optOutItems array of OptOutItem

オプトアウト項目を取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadPanelDefinitionResponse

このクラスは、ReadPanelDefinition API の返却パラメーターを表します。

名前 パス 型 説明
パネル
 panel PanelDefinition

このクラスには、顧客定義のパネルに含まれるすべてのフィールドの完全な定義が含まれています。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadSamplingProjectResponse

このクラスは、ReadSamplingProject API の返却パラメーターを表します。

名前 パス 型 説明
samplingProject
 samplingProject SamplingProjectElement

このクラスは、サンプリング プロジェクトを表します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadSurveyLinksResponse

このクラスは、ReadSurveyLinks API の応答を表します。

名前 パス 型 説明
anonymousList
 anonymousList array of SurveyLink

匿名の一覧を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadSurveyListResponse

このクラスは、ReadSurveyList API の応答パラメーターを表します。

名前 パス 型 説明
アンケート
 surveys array of SurveyListItem

アンケートを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadSurveyResponse

このクラスは、ReadSurveyDefinition API の返却パラメーターを表します。

名前 パス 型 説明
surveyName
 surveyName string

アンケートの名前を取得または設定します。
surveyVersion
 surveyVersion integer

アンケート バージョンを取得または設定します。
surveyState
 surveyState string

アンケートの状態を取得または設定します。
createdAt
 createdAt string

作成日時を取得または設定します。
createdBy
 createdBy string

作成者を取得または設定します。
調査
 survey SurveyDefinition

このクラスは、すべてのメタデータと設定を含む調査の定義を表します。
surveyConfiguration
 surveyConfiguration SurveyConfiguration

このクラスは、ユーザーが構成できるすべての設定を含むアンケート構成を表します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadWebHookListResponse

このクラスは、ReadWebHookList API の返却パラメーターを表します。

名前 パス 型 説明
webHooks
 webHooks array of WebHookElement

Web hook を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadWorkflowTransitionsResponse

このクラスは、ReadWorkflowTransitions API の返却パラメーターを表します。

名前 パス 型 説明
移行
 transitions array of WorkflowTransition

切り替えを取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ReadWorkspaceListResponse

このクラスは、ReadWorkspaceList API の要求パラメーターを表します。

名前 パス 型 説明
ワークスペース
 workspaces array of WorkspaceDto

ワークスペースを取得または設定します。
totalCount
 totalCount integer

合計数を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

RedeemIncentiveCodeResponse

このクラスは、RedeemIncentiveCode API の返却パラメーターを表します。

名前 パス 型 説明
voucherCode
 voucherCode string

伝票コードを取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

RemindMembersResponse

このクラスは、RemindMembers API の返却パラメーターを表します。

名前 パス 型 説明
reminderId
 reminderId integer

リマインダー識別子を取得または設定します。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ResetInterviewResponse

このクラスは、ResetInterview API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

Row

このクラスは 1 つの行項目を表します。

名前 パス 型 説明
columns
 columns array of ColItem

列を取得または設定します。

RowItem

このクラスは、アンケート回答を表します。

名前 パス 型 説明
id
 id string

識別子の取得または設定。
価値
 value string

値を取得または設定します。

SamplingProjectElement

このクラスは、サンプリング プロジェクトを表します。

名前 パス 型 説明
samplingProjectId
 samplingProjectId integer

サンプリング プロジェクトの識別子を取得または設定します。
名称
 name string

名前を取得または設定します。
workspaceId
 workspaceId integer

ワークスペース識別子を取得または設定します。
surveyId
 surveyId integer

アンケート識別子を取得または設定します。
surveyVersion
 surveyVersion integer

アンケート バージョンを取得または設定します。
panelId
 panelId integer

パネル識別子を取得または設定します。
samplingProviderId
 samplingProviderId integer

サンプリング プロバイダーの識別子を取得または設定します。
projectState
 projectState string

プロジェクトの状態を取得または設定します。
scheduledDistribution
 scheduledDistribution string

スケジュールされた配分を取得または設定します。
executedDistribution
 executedDistribution string

実行された配分を取得または設定します。
conditions
 conditions array of ConditionDefinition

条件を取得または設定します。

ScriptType

ScriptType

ScriptType

string

セクション​​

このクラスは、アンケート内のセクションを表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
名称
 name string

名前を取得または設定します。
randomizePages
 randomizePages boolean

[ページをランダム化する] かどうかを示す値を取得または設定します。
excludeFromRandomization
 excludeFromRandomization boolean

[ランダム化から除外する] かどうかを示す値を取得または設定します。
要素
 elements array of SurveyElement

要素を取得または設定します。
条件
 condition ConditionDefinition

このクラスは条件要素の定義を表します。

SurveyConfiguration

このクラスは、ユーザーが構成できるすべての設定を含むアンケート構成を表します。

名前 パス 型 説明
designConfiguration
 designConfiguration DesignConfiguration

このクラスは、アカウントのスタイル設定の可能性を表します。
anonymizingConfiguration
 anonymizingConfiguration AnonymizingConfiguration

このクラスには、ワークスペース グループ、ワークスペース、または個々のアンケートに適用できる匿名化設定が含まれています。

SurveyCreditLog

このクラスは、単一のクレジット トランザクションを表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
oldValue
 oldValue string

過去の値を取得または設定します。
newValue
 newValue string

新しい値を取得または設定します。
description
 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
 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
 code string

コードを取得または設定します。
codeManuallyChanged
 codeManuallyChanged boolean

[コードが手動で変更された] かどうかを示す値を取得または設定します。
text
 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

ColumnType
prompt
 prompt array of TranslationElement

プロンプトを取得または設定します。
minValue
 minValue integer

最小値を取得または設定します。
maxValue
 maxValue integer

最大値を取得または設定します。
showCenterLabel
 showCenterLabel boolean

[中間レベルを表示する] かどうかを示す値を取得または設定します。
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
 dislikeText array of TranslationElement

"興味なし" テキスト翻訳を取得または設定します。
hasStartText
 hasStartText boolean

このインスタンスにスタート テキストがあるかどうかを示す値を取得または設定します。
startText
 startText array of TranslationElement

開始テキストを取得または設定します。
enableMeasurement
 enableMeasurement boolean

[測定を有効にする] かどうかを示す値を取得または設定します。
showButtons
 showButtons boolean

[ボタンを表示する] かどうかを示す値を取得または設定します。
likeKey
 likeKey string

いいね! キーを取得または設定します。
dislikeKey
 dislikeKey string

興味なしキーを取得または設定する。
interviewState
 interviewState string

応答の状態を取得または設定します。
action
 action ActionElement

このクラスは、完了/スクリーンアウト/クォータの調査アクションの終了を表します。
送信元
 from string

送信者を取得または設定します。
送信先
 to string

受信者を取得または設定します。
subject
 subject array of TranslationElement

件名の翻訳を取得または設定します。
message
 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 ConditionDefinition

このクラスは条件要素の定義を表します。
evaluateAsJson
 evaluateAsJson boolean

[JASON として評価する] かどうかを示す値を取得または設定します。
autocompleteListVariable
 autocompleteListVariable string

オートコンプリート一覧の変数を取得または設定します。
arrangementMode
 arrangementMode ArrangementMode

ArrangementMode
enableAnimation
 enableAnimation boolean

[アニメーションを有効にする] かどうかを示す値を取得または設定します。
useSmiley
 useSmiley boolean

[顔文字を使用する] かどうかを示す値を取得または設定します。
hasPrompt
 hasPrompt boolean

このインスタンスにプロンプトがあるかどうかを示す値を取得または設定します。

SurveyLink エンティティ

名前 パス 型 説明
url
 url string

URL を取得または設定します。
isCustom
 isCustom boolean

このインスタンスがカスタムかどうかを示す値を取得または設定します。
language
 language string

言語を取得または設定します。

SurveyListItem

このクラスは、単一のアンケート項目を表します。

名前 パス 型 説明
id
 id integer

調査の ID
名称
 name string

アンケートの名前
modifiedDate
 modifiedDate string

アンケートの変更日
endDate
 endDate string

アンケートが終了する日付
isEndDateEnabled
 isEndDateEnabled boolean

このアンケートに対して終了日が有効になっている場合
ステータス
 status SurveyStatus

SurveyStatus
archiveDate
 archiveDate string

アンケートがアーカイブされる日付
statusOn
 statusOn boolean

アンケートがオンかオフか
回答
 answers integer

回答を取得または設定します。

SurveyMetadataItem

このクラスは、単一のメタデータ項目を表します。

名前 パス 型 説明
code
 code string

コードを取得または設定します。
dataType
 dataType string

データ タイプを取得または設定します。
questionCode
 questionCode string

質問コードを取得または設定します。
タイプ
 type string

種類を取得または設定します。
question
 question string

質問を取得または設定します。
行
 row string

行を取得または設定します。
選択肢
 choice string

選択肢を取得または設定します。
values
 values array of RowItem

値を取得または設定します。
sectionName
 sectionName string

セクション名を取得または設定します。

SurveyStatus

SurveyStatus

SurveyStatus

string

TextBlock

TextBlock

名前 パス 型 説明
名称
 name string

名前を取得または設定します。
タイプ
 type string

種類を取得または設定します。
text
 text array of TranslationElement

テキストを取得または設定します。

TextFieldSize

TextFieldSize

TextFieldSize

string

TranslationElement

このクラスは、アンケート内のテキスト翻訳を表します。

名前 パス 型 説明
languageCode
 languageCode string

言語コードの取得または設定。
text
 text string

テキストを取得または設定します。

UpdateMembersResponse

このクラスは、UpdateMembers API の返却パラメーターを表します。

名前 パス 型 説明
validationIssues
 validationIssues array of WritePanelMemberIssue

問題を取得または設定する。
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

UpdateSurveyResponse

このクラスは、UpdateSurvey API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

UpdateWebHookResponse

このクラスは、CreateWebHook API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

ValueAssignmentType

ValueAssignmentType

ValueAssignmentType

string

VariableGroupElement

このクラスは、パネル内のフィールドのグループを表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
名称
 name string

名前を取得または設定します。
displayName
 displayName string

表示名を取得または設定します。
fields
 fields array of PanelFieldItem

フィールドを取得または設定します。

VariableType

VariableType

VariableType

string

WebHookElement

このクラスは、単一の WebHook を表します

名前 パス 型 説明
id
 id uuid

識別子の取得または設定。
eventType
 eventType EventType

EventType
entityIdentifier
 entityIdentifier string

エンティティ識別子を取得または設定します。
createdAt
 createdAt date-time

作成日時を取得または設定します。
createdBy
 createdBy string

作成者を取得または設定します。
updatedAt
 updatedAt date-time

更新日時を取得または設定します。
updatedBy
 updatedBy string

更新者を取得または設定します。

WorkflowTransition

このクラスは、ある状態から別の状態への 1 つの切り替えを表します。

名前 パス 型 説明
名称
 name string

名前を取得または設定します。
action
 action string

アクションの名前を取得または設定します。
newState
 newState string

新しい状態を作成します。
条件
 condition string

条件を取得または設定します。

WorkspaceDto

このクラスは 1 つのワークスペース エンティティを表します。

名前 パス 型 説明
id
 id integer

識別子の取得または設定。
名称
 name string

名前を取得または設定します。
numberOfSurveys
 numberOfSurveys integer

アンケート数を取得または設定します。

WriteOptOutListResponse

このクラスは、WriteOptOutList API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。

WritePanelMemberIssue

発生する可能性のある問題を表します

名前 パス 型 説明
errorCode
 errorCode string

エラー コードを取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。

WritePanelResponse

このクラスは、WritePanel API の返却パラメーターを表します。

名前 パス 型 説明
IsSuccess
 isSuccess boolean

このインスタンスが成功したかどうかを示す値を取得または設定します。
errorMessage
 errorMessage string

エラー メッセージを取得または設定します。
errorCode
 errorCode string

エラー コードを取得または設定します。