Definitions :: Public APIs

AddCustomTable

Name	Schema
dataSetName optional	string
dataSetSubType optional	string
defaultLanguageId optional	integer (int32)
fields optional	< CustomTableField > array
label optional	string
labelFieldName optional	string
languageIds optional	< integer (int32) > array
name optional	string

Name

Schema

dataSetName
optional

string

dataSetSubType
optional

string

defaultLanguageId
optional

integer (int32)

fields
optional

< CustomTableField > array

label
optional

string

labelFieldName
optional

string

languageIds
optional

< integer (int32) > array

name
optional

string

AddDataResource

Name	Schema
documents optional	< DataDocument > array

Name

Schema

documents
optional

< DataDocument > array

AddHierarchyResource

Name	Schema
companyId optional	integer (int32)
defaultLanguage optional	integer (int32)
enableNodeAssignments optional	boolean
languages optional	< integer (int32) > array
listId optional	integer (int32)
name optional	string

Name

Schema

companyId
optional

integer (int32)

defaultLanguage
optional

integer (int32)

enableNodeAssignments
optional

boolean

languages
optional

< integer (int32) > array

listId
optional

integer (int32)

name
optional

string

AddHierarchyUploadJobResource

Name	Schema
importMode optional	HierarchyImportMode

Name

Schema

importMode
optional

HierarchyImportMode

AddJobResource

Name	Schema
levels optional	< DataSetLevel > array

Name

Schema

levels
optional

< DataSetLevel > array

AddSchemaResponse

Name	Schema
incompatibleReason optional	string
isCompatible optional	boolean

Name

Schema

incompatibleReason
optional

string

isCompatible
optional

boolean

AddSurveyProperties

Name	Schema
apiKey optional	string
levels optional	< string > array
name optional	string
originUrn optional	string
publicName optional	string
server optional	string

Name

Schema

apiKey
optional

string

levels
optional

< string > array

name
optional

string

originUrn
optional

string

publicName
optional

string

server
optional

string

ConfirmitLanguage

Name	Schema
confirmitLanguageId optional	integer (int32)

Name

Schema

confirmitLanguageId
optional

integer (int32)

CustomDataDeleteDataSchema

Name	Schema
keys optional	< string > array

Name

Schema

keys
optional

< string > array

CustomDataDeleteObject

Name	Schema
data optional	< < string, object > map > array
dataSchema optional	CustomDataDeleteDataSchema

Name

Schema

data
optional

< < string, object > map > array

dataSchema
optional

CustomDataDeleteDataSchema

CustomDataWriteDataSchema

Name	Schema
fieldNames optional	< string > array

Name

Schema

fieldNames
optional

< string > array

CustomDataWriteObject

Name	Schema
data optional	< < string, object > map > array
dataSchema optional	CustomDataWriteDataSchema

Name

Schema

data
optional

< < string, object > map > array

dataSchema
optional

CustomDataWriteDataSchema

CustomTable

Name	Schema
created optional	string (date-time)
createdByUserId optional	integer (int32)
dataSetId optional	string
dataSetPublicName optional	string
hubId optional	integer (int64)
id optional	integer (int32)
lastAccessed optional	string (date-time)
lastModified optional	string (date-time)
links optional	< string, object > map
name optional	string
publicName optional	string
subType optional	string

Name

Schema

created
optional

string (date-time)

createdByUserId
optional

integer (int32)

dataSetId
optional

string

dataSetPublicName
optional

string

hubId
optional

integer (int64)

id
optional

integer (int32)

lastAccessed
optional

string (date-time)

lastModified
optional

string (date-time)

links
optional

< string, object > map

name
optional

string

publicName
optional

string

subType
optional

string

CustomTableField

Name	Schema
categories optional	< CustomTableFieldCategory > array
dataType optional	FieldDataType
id optional	integer (int64)
isLanguageDependent optional	boolean
isPrimaryKey optional	boolean
label optional	string
length optional	integer (int32)
links optional	< string, object > map
name optional	string
precision optional	integer (int32)
scale optional	integer (int32)

Name

Schema

categories
optional

< CustomTableFieldCategory > array

dataType
optional

FieldDataType

id
optional

integer (int64)

isLanguageDependent
optional

boolean

isPrimaryKey
optional

boolean

label
optional

string

length
optional

integer (int32)

links
optional

< string, object > map

name
optional

string

precision
optional

integer (int32)

scale
optional

integer (int32)

CustomTableFieldCategory

Name	Schema
code optional	string
labels optional	< CustomTableFieldCategoryLabel > array
links optional read-only	< string, object > map

Name

Schema

code
optional

string

labels
optional

< CustomTableFieldCategoryLabel > array

links
optional
read-only

< string, object > map

CustomTableFieldCategoryLabel

Name	Schema
label optional	string
language optional	integer (int32)

Name

Schema

label
optional

string

language
optional

integer (int32)

CustomTableRecord

Type : < string, object > map

DataDocument

Name	Schema
document optional	object
isDeleted optional	boolean
version optional	integer (int64)

Name

Schema

document
optional

object

isDeleted
optional

boolean

version
optional

integer (int64)

DataSchemaField

Name	Schema
code optional	string
hasOtherField optional	boolean
listSource optional	string
loopReference optional	string
texts optional	< LanguageText > array
urn optional	string

Name

Schema

code
optional

string

hasOtherField
optional

boolean

listSource
optional

string

loopReference
optional

string

texts
optional

< LanguageText > array

urn
optional

string

DataSchemaRelation

Name	Schema
fields optional	< Relation > array
isOneToOne optional	boolean
name optional	string
parent optional	string

Name

Schema

fields
optional

< Relation > array

isOneToOne
optional

boolean

name
optional

string

parent
optional

string

DataSchemaVariable

Name	Schema
databaseDesignerReference optional	DatabaseDesignerReference
excludeFromReporting optional	boolean
fields optional	< DataSchemaField > array
isBackground optional	boolean
isCompound optional	boolean
isHidden optional	boolean
isRespondentVariable optional	boolean
isSystemVariable 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

Name

Schema

databaseDesignerReference
optional

DatabaseDesignerReference

excludeFromReporting
optional

boolean

fields
optional

< DataSchemaField > array

isBackground
optional

boolean

isCompound
optional

boolean

isHidden
optional

boolean

isRespondentVariable
optional

boolean

isSystemVariable
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

DataSetLevel

Name	Schema
dataVersion optional	integer (int64)
name optional	string
schemaVersion optional	integer (int64)

Name

Schema

dataVersion
optional

integer (int64)

name
optional

string

schemaVersion
optional

integer (int64)

DatabaseDesignerReference

Name	Schema
id optional	integer (int32)
schemaId optional	integer (int32)

Name

Schema

id
optional

integer (int32)

schemaId
optional

integer (int32)

EndUser

Name Description Schema

Name	Description	Schema
comment optional	Maximal length : `50`	string
email optional	Maximal length : `254`	string
firstName optional	Maximal length : `50`	string
id optional		integer (int32)
isActive optional		boolean
language optional		integer (int32)
lastName optional	Maximal length : `50`	string
links optional read-only		< string, object > map
userName optional	Maximal length : `150`	string

comment
optional

Maximal length : 50

string

email
optional

Maximal length : 254

string

firstName
optional

Maximal length : 50

string

id
optional

integer (int32)

isActive
optional

boolean

language
optional

integer (int32)

lastName
optional

Maximal length : 50

string

links
optional
read-only

< string, object > map

userName
optional

Maximal length : 150

string

EndUserFilterQuery

Name Description Schema

Name	Description	Schema
isActive optional		boolean
searchText optional		string
skip optional	Minimum value : `0` Maximum value : `50000`	integer (int32)
sortBy optional	Pattern : `"^(Username\|FirstName\|LastName\|Email\|IsActive\|UserId)?$"`	string
sortByAscending optional		boolean
top optional	Minimum value : `0` Maximum value : `50000`	integer (int32)

isActive
optional

boolean

searchText
optional

string

skip
optional

Minimum value : 0
Maximum value : 50000

integer (int32)

sortBy
optional

string

sortByAscending
optional

boolean

top
optional

Minimum value : 0
Maximum value : 50000

integer (int32)

EndUserList

Name	Schema
id optional	integer (int32)
links optional read-only	< string, object > map
name optional	string

Name

Schema

id
optional

integer (int32)

links
optional
read-only

< string, object > map

name
optional

string

FieldDataType

Type : enum (date, dateTime, numeric, boolean, text, categorical, parentRelation, reference, undefined)

HierarchyImportMode

Type : enum (updateExistingAndAddNew, replaceAll)

HierarchyListResource

Name	Schema
companyId optional	integer (int32)
companyName optional	string
created optional	string (date-time)
createdBy optional	string
id optional	integer (int32)
lastModified optional	string (date-time)
lastModifiedBy optional	string
name optional	string

Name

Schema

companyId
optional

integer (int32)

companyName
optional

string

created
optional

string (date-time)

createdBy
optional

string

id
optional

integer (int32)

lastModified
optional

string (date-time)

lastModifiedBy
optional

string

name
optional

string

HierarchyNodeResource

Name	Schema
id optional	string
label optional	string
parentId optional	string

Name

Schema

id
optional

string

label
optional

string

parentId
optional

string

HierarchyResource

Name	Schema
companyId optional	integer (int32)
companyName optional	string
defaultLanguage optional	integer (int32)
endUserListId optional	integer (int32)
hierarchyGuid optional	string (uuid)
id optional	integer (int32)
languages optional	< integer (int32) > array
name optional	string
nodeAssignmentsEnabled optional	boolean
schemaGuid optional	string (uuid)
schemaId optional	integer (int32)
schemaName optional	string
tableId optional	integer (int32)
tableName optional	string

Name

Schema

companyId
optional

integer (int32)

companyName
optional

string

defaultLanguage
optional

integer (int32)

endUserListId
optional

integer (int32)

hierarchyGuid
optional

string (uuid)

id
optional

integer (int32)

languages
optional

< integer (int32) > array

name
optional

string

nodeAssignmentsEnabled
optional

boolean

schemaGuid
optional

string (uuid)

schemaId
optional

integer (int32)

schemaName
optional

string

tableId
optional

integer (int32)

tableName
optional

string

HierarchyUploadJobResource

Name	Schema
id optional	integer (int32)
links optional	< string, object > map
status optional	TaskStatus

Name

Schema

id
optional

integer (int32)

links
optional

< string, object > map

status
optional

TaskStatus

Hub

Name	Schema
companyId optional	integer (int32)
companyName optional	string
description optional	string
hubId optional	integer (int64)
links optional	< string, object > map
name optional	string

Name

Schema

companyId
optional

integer (int32)

companyName
optional

string

description
optional

string

hubId
optional

integer (int64)

links
optional

< string, object > map

name
optional

string

HubSourceTypeModel

Type : enum (survey, autoMappedCombined, manualMappedCombined)

HubSurvey

Name	Schema
links optional	< string, object > map
name optional	string
sourceId optional	string
sourceType optional	HubSourceTypeModel
subType optional	string
surveyId optional	string

Name

Schema

links
optional

< string, object > map

name
optional

string

sourceId
optional

string

sourceType
optional

HubSourceTypeModel

subType
optional

string

surveyId
optional

string

JobResource

Name	Schema
created optional	string (date-time)
dataSetId optional	string
id optional	integer (int64)
levels optional	< DataSetLevel > array
links optional	Links
status optional	JobStatus

Name

Schema

created
optional

string (date-time)

dataSetId
optional

string

id
optional

integer (int64)

levels
optional

< DataSetLevel > array

links
optional

Links

status
optional

JobStatus

Type : enum (staging, stagingCompleted, committing, succeeded, canceled, failed)

LanguageText

Name	Schema
languageId optional	integer (int32)
text optional	string

Name

Schema

languageId
optional

integer (int32)

text
optional

string

Level

Name	Schema
children optional	< Level > array
keys optional	< DataSchemaVariable > array
name optional	string
relations optional	< DataSchemaRelation > array
texts optional	< LanguageText > array
variables optional	< DataSchemaVariable > array

Name

Schema

children
optional

< Level > array

keys
optional

< DataSchemaVariable > array

name
optional

string

relations
optional

< DataSchemaRelation > array

texts
optional

< LanguageText > array

variables
optional

< DataSchemaVariable > array

LimitType

Type : enum (noLimit, inclusive, exclusive)

Links

Name	Schema
self optional	string

Name

Schema

self
optional

string

Node

Name	Schema
children optional	< Node > array
code optional	string
texts optional	< LanguageText > array

Name

Schema

children
optional

< Node > array

code
optional

string

texts
optional

< LanguageText > array

NodeAssignment

Name	Schema
links optional read-only	< string, object > map
nodeId optional	string
role optional	string
userName optional	string

Name

Schema

links
optional
read-only

< string, object > map

nodeId
optional

string

role
optional

string

userName
optional

string

Operation

Name	Schema
from optional	string
op optional	string
path optional	string
value optional	object

Name

Schema

from
optional

string

op
optional

string

path
optional

string

value
optional

object

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

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

ProblemDetails

Name	Schema
detail optional	string
extensions optional	< string, object > map
instance optional	string
status optional	integer (int32)
title optional	string
type optional	string

Name

Schema

detail
optional

string

extensions
optional

< string, object > map

instance
optional

string

status
optional

integer (int32)

title
optional

string

type
optional

string

PublicApiError

Name	Schema
correlationId optional	string
message optional	string

Name

Schema

correlationId
optional

string

message
optional

string

RelatedDataSet

Name	Schema
links optional	< string, object > map
name optional	string
publicName optional	string
sourceId optional	string
sourceType optional	HubSourceTypeModel
subType optional	string

Name

Schema

links
optional

< string, object > map

name
optional

string

publicName
optional

string

sourceId
optional

string

sourceType
optional

HubSourceTypeModel

subType
optional

string

Relation

Name	Schema
child optional	string
parent optional	string

Name

Schema

child
optional

string

parent
optional

string

ResourceCollectionWithLinks[HierarchyListResource]

Name	Schema
itemCount optional	integer (int32)
items optional	< HierarchyListResource > array
links optional	< string, string > map
totalCount optional	integer (int32)

Name

Schema

itemCount
optional

integer (int32)

items
optional

< HierarchyListResource > array

links
optional

< string, string > map

totalCount
optional

integer (int32)

ResourceCollectionWithLinks[Hub]

Name	Schema
itemCount optional	integer (int32)
items optional	< Hub > array
links optional	< string, string > map
totalCount optional	integer (int32)

Name

Schema

itemCount
optional

integer (int32)

items
optional

< Hub > array

links
optional

< string, string > map

totalCount
optional

integer (int32)

ResourceCollection[CustomTableField]

Name	Schema
itemCount optional	integer (int32)
itemType optional	string
items optional	< CustomTableField > array
links optional	< string, object > map
totalCount optional	integer (int32)

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< CustomTableField > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[CustomTableRecord]

Name	Schema
itemCount optional	integer (int32)
itemType optional	string
items optional	< CustomTableRecord > array
links optional	< string, object > map
totalCount optional	integer (int32)

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< CustomTableRecord > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[CustomTable]

Name	Schema
itemCount optional	integer (int32)
itemType optional	string
items optional	< CustomTable > array
links optional	< string, object > map
totalCount optional	integer (int32)

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< CustomTable > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[EndUserList]

Name	Schema
itemCount optional	integer (int32)
itemType optional	string
items optional	< EndUserList > array
links optional	< string, object > map
totalCount optional	integer (int32)

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< EndUserList > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[EndUser]

Name	Schema
itemCount optional	integer (int32)
itemType optional	string
items optional	< EndUser > array
links optional	< string, object > map
totalCount optional	integer (int32)

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< EndUser > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[HierarchyNodeResource]

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< HierarchyNodeResource > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[HubSurvey]

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< HubSurvey > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[NodeAssignment]

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< NodeAssignment > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[RelatedDataSet]

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< RelatedDataSet > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[SurveyDataRecord]

Name

Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< < string, object > map > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

SurveyDataSchema

Name

Schema

defaultConfirmitLanguageId
optional

integer (int32)

languages
optional

< ConfirmitLanguage > array

name
optional

string

root
optional

Level

version
optional

string

SurveyState

Name

Schema

links
optional

object

stateId
optional

integer (int64)

TaskStatus

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

VariableType

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