Definitions

Invite

Name Schema

css
optional

string

html
optional

string

id
optional

integer (int32)

lastModified
optional

string (date-time)

links
optional

< string, object > map

name
optional

string

programId
optional

integer (int32)

InvitePayload

Name Schema

css
optional

string

html
optional

string

name
optional

string

MovePosition

Type : enum (Before, After)

MoveScenarioPayload

Name Schema

position
optional

MovePosition

targetId
optional

integer (int32)

Overlay

Name Schema

css
optional

string

html
optional

string

id
optional

integer (int32)

lastModified
optional

string (date-time)

links
optional

< string, object > map

name
optional

string

programId
optional

integer (int32)

OverlayPayload

Name Schema

css
optional

string

html
optional

string

name
optional

string

Program

Name Schema

companyId
optional

integer (int32)

companyName
optional

string

created
optional

string (date-time)

createdBy
optional

integer (int32)

createdByUser
optional

string

customDomainOverride
optional

string

description
optional

string

enableSri
optional

boolean

hubId
optional

integer (int64)

id
optional

integer (int32)

isPublished
optional

boolean

lastModified
optional

string (date-time)

lastModifiedBy
optional

integer (int32)

lastModifiedByUser
optional

string

lastPublished
optional

string (date-time)

links
optional

< string, object > map

loaderLink
optional

ScriptLink

name
optional

string

previewUrl
optional

string

programType
optional

ProgramType

publicKey
optional

string

version
optional

integer (int32)

ProgramPayload

Name Schema

customDomainOverride
optional

string

description
optional

string

enableSri
optional

boolean

hubId
optional

integer (int64)

name
optional

string

programType
optional

ProgramType

ProgramSurvey

Name Schema

links
optional

< string, object > map

programId
optional

integer (int32)

surveyId
optional

string

ProgramType

Type : enum (WEB, SDK)

PublishResponse

Name Schema

loaderLink
optional

ScriptLink

ResourceCollection[Invite]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Invite > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[Overlay]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Overlay > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[ProgramSurvey]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< ProgramSurvey > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[Program]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Program > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[ScenarioParameter]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< ScenarioParameter > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[ScenarioTemplateParameter]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< ScenarioTemplateParameter > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[ScenarioTemplate]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< ScenarioTemplate > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[Scenario]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Scenario > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

RootResponse

Name Schema

id
optional

string

links
optional

< string, object > map

Scenario

Name Schema

id
optional

integer (int32)

isEnabled
optional

boolean

lastModified
optional

string (date-time)

links
optional

< string, object > map

name
optional

string

programId
optional

integer (int32)

scenarioType
optional

ScenarioType

script
optional

string

templateId
optional

integer (int32)

ScenarioParameter

Name Schema

links
optional

< string, object > map

name
optional

string

value
optional

string

ScenarioParameterPayload

Name Schema

value
optional

string

ScenarioPatchPayload

Name Schema

isEnabled
optional

boolean

ScenarioPayload

Name Schema

name
optional

string

scenarioType
optional

ScenarioType

script
optional

string

templateId
optional

integer (int32)

ScenarioTemplate

Name Schema

code
optional

string

funcName
optional

string

id
optional

integer (int32)

lastModified
optional

string (date-time)

links
optional

< string, object > map

name
optional

string

programId
optional

integer (int32)

ScenarioTemplateParameter

Name Schema

addButtonLabel
optional

string

caption
optional

string

desc
optional

string

keyLabel
optional

string

keyLabelRight
optional

string

keyLabelTop
optional

string

keyType
optional

ScenarioTemplateParameterType

label
optional

string

labelRight
optional

string

labelTop
optional

string

links
optional

< string, object > map

name
optional

string

type
optional

ScenarioTemplateParameterType

valueLabel
optional

string

valueLabelRight
optional

string

valueLabelTop
optional

string

valueType
optional

ScenarioTemplateParameterType

ScenarioTemplateParameterPayload

Name Schema

addButtonLabel
optional

string

caption
optional

string

desc
optional

string

keyLabel
optional

string

keyLabelRight
optional

string

keyLabelTop
optional

string

keyType
optional

ScenarioTemplateParameterType

label
optional

string

labelRight
optional

string

labelTop
optional

string

name
optional

string

type
optional

ScenarioTemplateParameterType

valueLabel
optional

string

valueLabelRight
optional

string

valueLabelTop
optional

string

valueType
optional

ScenarioTemplateParameterType

ScenarioTemplateParameterType

Type : enum (String, Number, Map, Survey, Invite, Container, Expr)

ScenarioTemplatePayload

Name Schema

code
optional

string

name
optional

string

ScenarioType

Type : enum (Normal, TemplateBased)

ScriptLink

Name Schema

integrity
optional

string

url
optional

string

SurveyPayload

Name Schema

surveyId
optional

string