Definitions

CATISchedulingMode

Type : enum (none, full, simple)

CellValidationMessage

Name Schema

fields
optional

< string > array

message
optional

string

severity
optional

ValidationErrorSeverity

value
optional

string

ConfirmitLanguage

Name Schema

confirmitLanguageId
optional

integer (int32)

DataSchemaVariable

Name Schema

databaseDesignerReference
optional

DatabaseDesignerReference

excludeFromReporting
optional

boolean

fields
optional

< Field > array

isBackground
optional

boolean

isCompound
optional

boolean

isHidden
optional

boolean

isSystemVariable
optional

boolean

isUserVariable
optional

boolean

length
optional

integer (int32)

lowerLimitType
optional

LimitType

lowerNumericLimit
optional

number (double)

name
optional

string

nodes
optional

< Node > array

options
optional

< Option > array

parentVariableName
optional

string

precision
optional

integer (int32)

scale
optional

integer (int32)

tags
optional

< string > array

texts
optional

< LanguageText > array

titles
optional

< LanguageText > array

upperLimitType
optional

LimitType

upperNumericLimit
optional

number (double)

variableType
optional

VariableType

DataState

Name Description Schema

currentChangeTrackingVersion
optional

The current change tracking version in the survey database.

integer (int64)

lastCleanData
optional

Timestamp of when a clean all responses operation was performed on the survey database.

string (date-time)

lastCreateNew
optional

Timestamp of when the survey database was last launched with the Create New Database option.

string (date-time)

lastLaunch
optional

Timestamp of when the survey database was last launched.

string (date-time)

lastRestored
optional

Timestamp of when a restore (from a backup) of the survey database was performed.

string (date-time)

links
optional

< string, string > map

maxLastTouched
optional

Timestamp of the last change to the response data.

string (date-time)

DatabaseDesignerReference

Name Schema

id
optional

integer (int32)

schemaId
optional

integer (int32)

DatabaseGenerationMode

Specify what is to be done with existing storage.

Be aware, that if you use 'CreateNew' mode, all data including survey responses and respondents will be deleted. This action is IRREVERSIBLE.

Type : enum (createNew, rebuild)

DbEnvironment

Type : enum (production, test)

Dimension

Name Schema

name
optional

string

values
optional

< string > array

DimensionKey

Name Schema

name
optional

string

value
optional

string

DocumentValidationResult

Name Schema

level
optional

string

rowResults
optional

< RowValidationResult > array

Factor

Name Schema

key
optional

< DimensionKey > array

weight
optional

number (double)

Field

Name Schema

code
optional

string

hasOtherField
optional

boolean

listSource
optional

string

loopReference
optional

string

texts
optional

< LanguageText > array

urn
optional

string

HierarchyModel

Name Schema

id
optional

integer (int32)

name
optional

string

nodes
optional

< HierarchyNodeModel > array

HierarchyNodeModel

Name Schema

attributes
optional

< string, string > map

children
optional

< HierarchyNodeModel > array

id
optional

string

label
optional

string

Import

Name Schema

projectId
optional

string

InsertRespondentDataResource

Name Schema

data
optional

< < string, object > map > array

dataSchema
optional

SurveyWriteDataSchema

schedulingMode
optional

CATISchedulingMode

InsertResponseDataResource

Name Description Schema

data
optional

< < string, object > map > array

dataSchema
optional

SurveyWriteDataSchema

linkRespondentsWithKey
optional

Example : false

boolean

Language

Name Schema

countryName
optional

string

id
optional

integer (int32)

name
optional

string

primaryLanguageId
optional

integer (int32)

rightToLeft
optional

boolean

subLanguages
optional

< Language > array

LanguageSelectionType

Type : enum (all, none, default, selected)

LanguageText

Name Schema

languageId
optional

integer (int32)

text
optional

string

Launch

Contains information about single survey launch.

Name Description Schema

id
optional

Launch id.

integer (int32)

links
optional

Hyperlinks.

< string, object > map

logs
optional

LogItemCollection

status
optional

Status

taskId
optional

Task id in the task system.

integer (int32)

LaunchItemCollection

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Launch > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

Level

Name Schema

children
optional

< Level > array

keys
optional

< DataSchemaVariable > array

name
optional

string

texts
optional

< LanguageText > array

variables
optional

< DataSchemaVariable > array

LimitType

Type : enum (noLimit, inclusive, exclusive)

LiveLimitType

Type : enum (fixed, percent)

Log

Name Schema

error
optional

string

links
optional

< string, object > map

text
optional

string

timeStamp
optional

string (date-time)

type
optional

LogType

LogItemCollection

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Log > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

LogType

Type : enum (info, warning, error)

LogTypes

Types of log entries.

Type : enum (info, warning, error, all)

MergeRespondentDataResource

Name Schema

data
optional

< < string, object > map > array

dataSchema
optional

SurveyWriteDataSchema

schedulingMode
optional

CATISchedulingMode

MergeResponseDataResource

Name Description Schema

data
optional

< < string, object > map > array

dataSchema
optional

SurveyWriteDataSchema

linkRespondentsWithKey
optional

Example : false

boolean

Mode

Survey launch modes.

Type : enum (production, test, externalTest, externalQuickTest)

Node

Name Schema

children
optional

< Node > array

code
optional

string

texts
optional

< LanguageText > array

Option

Name Schema

code
optional

string

hasOtherField
optional

boolean

listSource
optional

string

loopReference
optional

string

score
optional

number (double)

texts
optional

< LanguageText > array

urn
optional

string

PublicApiError

Name Schema

correlationId
optional

string

message
optional

string

validationMessages
optional

DocumentValidationResult

Quota

Name Description Schema

emailAddress
optional

Quota full notification email address.

string

isOptimisticQuota
optional

Enable optimistic quota.

boolean

links
optional

< string, object > map

liveLimit
optional

Only for optimistic quota. If LiveLimitType="fixed" then it’s responses over quota limit value. If LiveLimitType="percent" then it’s percentage over quota limit value.

integer (int32)

liveLimitType
optional

LiveLimitType

name
optional

Quota name.

string

QuotaField

Name Description Schema

answerCode
optional

Answer precode. Empty for Single questions.

string

answerText
optional

Answer text associated with the AnswerCode in a default survey language.

string

answerValue
optional

Answer value. For Single questions it’s an answer precode. For Multi questions it’s "1" or "0" if Chosen/Not chosen. For Grid questions it’s scale precode.

string

answerValueText
optional

Answer value text associated with the AnswerValue in a default survey language. For Multi questions it’s using predefined strings "Chosen" and "Not Chosen".

string

questionId
optional

Question name from the survey schema.

string

QuotaLimit

Name Description Schema

counter
optional

Quota counter value from the survey database

integer (int32)

fields
optional

Quota limit referenced form fields. Can be empty for 'Any' type limit.

< QuotaField > array

id
optional

Quota limit id

string (uuid)

limit
optional

Quota limit value from the survey schema

integer (int32)

QuotaLimitPatch

Name Schema

id
optional

string (uuid)

limit
optional

integer (int32)

ResourceCollection[Language]

Name Schema

itemCount
optional

integer (int32)

items
optional

< Language > array

links
optional

< string, string > map

totalCount
optional

integer (int32)

ResourceCollection[Quota]

Name Schema

itemCount
optional

integer (int32)

items
optional

< Quota > array

links
optional

< string, string > map

totalCount
optional

integer (int32)

ResourceCollection[SurveyDataRecord]

Name Schema

itemCount
optional

integer (int32)

items
optional

< < string, object > map > array

links
optional

< string, string > map

totalCount
optional

integer (int32)

ResourceCollection[SurveyHub]

Name Schema

itemCount
optional

integer (int32)

items
optional

< SurveyHub > array

links
optional

< string, string > map

totalCount
optional

integer (int32)

ResourceCollection[SurveyListItem]

Name Schema

itemCount
optional

integer (int32)

items
optional

< SurveyListItem > array

links
optional

< string, string > map

totalCount
optional

integer (int32)

ResourceCollection[WeightModel]

Name Schema

itemCount
optional

integer (int32)

items
optional

< WeightModel > array

links
optional

< string, string > map

totalCount
optional

integer (int32)

RowValidationResult

Name Schema

childResults
optional

< DocumentValidationResult > array

messages
optional

< CellValidationMessage > array

rowNumber
optional

integer (int32)

Status

Statuses of survey launch task.

Type : enum (queue, executing, aborted, error, complete)

Survey

Name Schema

companyId
optional

integer (int32)

companyName
optional

string

created
optional

string (date-time)

creatorFullName
optional

string

creatorUserName
optional

string

defaultLanguageId
optional

integer (int32)

description
optional

string

id
optional

string

keywords
optional

< string > array

languageIds
optional

< integer (int32) > array

lastDataStateChange
optional

string (date-time)

lastModified
optional

string (date-time)

links
optional

object

name
optional

string

status
optional

SurveyStatus

type
optional

SurveyType

SurveyDataChangeResponse

Name Schema

deletedRecords
optional

integer (int32)

insertedIds
optional

< integer (int32) > array

insertedRecords
optional

integer (int32)

updatedRecords
optional

integer (int32)

validationMessages
optional

DocumentValidationResult

SurveyDataQuery

Name Schema

links
optional

object

queryId
optional

integer (int64)

queryStatus
optional

SurveyDataQueryStatus

targetSurveyId
optional

string

SurveyDataQueryStatus

Type : enum (preparing, started, aborting, cancelled, aborted, completed)

SurveyDataSchema

Name Schema

defaultConfirmitLanguageId
optional

integer (int32)

languages
optional

< ConfirmitLanguage > array

links
optional

object

root
optional

Level

version
optional

string

SurveyDeleteDataObject

Name Schema

data
optional

< < string, object > map > array

dataSchema
optional

SurveyDeleteDataSchema

SurveyDeleteDataSchema

Name Schema

keys
optional

< string > array

name
optional

string

SurveyHub

Name Schema

hubId
optional

integer (int64)

links
optional

object

name
optional

string

SurveyLaunchOptions

Options for survey launching.

Name Description Schema

enforceNewVersion
optional

Should the new version of survey be enforced on currently answering respondents.

boolean

generationMode
optional

DatabaseGenerationMode

mode
optional

Mode

scheduleAt
optional

Date when the launching process should start. Set null to start immediately.

string (date-time)

SurveyListItem

Name Schema

companyId
optional

integer (int32)

companyName
optional

string

created
optional

string (date-time)

creatorFullName
optional

string

id
optional

string

keywords
optional

< string > array

lastDataStateChange
optional

string (date-time)

lastModified
optional

string (date-time)

links
optional

object

name
optional

string

status
optional

SurveyStatus

type
optional

SurveyType

wiLastGenerated
optional

string (date-time)

SurveyStatus

Type : enum (production, closed, design)

SurveyType

Type : enum (survey, pulseSurvey, autoCombinedSurvey)

SurveyWriteDataSchema

Name Schema

keys
optional

< string > array

variables
optional

< string > array

UpdateRespondentDataResource

Name Schema

data
optional

< < string, object > map > array

dataSchema
optional

SurveyWriteDataSchema

schedulingMode
optional

CATISchedulingMode

UserVariable

Name Schema

dataType
optional

UserVariableDataType

length
optional

integer (int32)

name
optional

string

precision
optional

integer (int32)

scale
optional

integer (int32)

UserVariableDataType

Type : enum (text, numeric, dateTime, boolean)

ValidationErrorSeverity

Type : enum (error, warning, info)

VariableType

Type : enum (singleChoice, multiChoice, rating, text, numeric, date, dateTime, boolean, ranking, hierarchy, geolocation, imageUpload, audioUpload, videoUpload, grid3D, multiGrid, info)

WeightModel

Name Schema

id
optional

string

lastGenerated
optional

string (date-time)

name
optional

string

questionId
optional

string

type
optional

WeightModelType

WeightModelDetails

Name Schema

dimensions
optional

< Dimension > array

factors
optional

< Factor > array

id
optional

string

lastGenerated
optional

string (date-time)

name
optional

string

questionId
optional

string

type
optional

WeightModelType

WeightModelType

Type : enum (sampleBalancing, sampleCellMatchingPercentage, cellMatchingWeight, surveyQuestion)