Members
-
UserTypeEnum
-
Description
Enums
-
stripHtml
-
Description
Functions
-
getFormValues
-
Description
Object support
-
getNgTemplates
-
Description
General application & client stuff
-
getAttachments
-
Description
Handle attachments
-
getCurrentInterruptionList
-
Description
Home & other ListItem[] functions
-
getKnowledgeArticle
-
Description
Knowledge
-
registerCase
-
Description
Case
-
getIncidentTopic
-
Description
Incident
-
getRequestItemList
-
Description
Request
-
getTicket
-
Description
Status & Ticket functions
-
registerComplaint
-
Description
Complaint
-
addDelegate
-
Description
Delegates & Approvals
-
submitSurvey
-
Description
Form & Survey handling functions
Type Definitions
-
TableDataDefinition
-
Properties
Name Type Description tablestring Table name to import data to
recordsArray.<Object> Records that are valid JSON records for the table
-
sys_id
-
Description
ServiceNOW unique record identifier
-
SimpleType
-
-
QueryInput
-
Description
Query input object, used for providing additional conditions to retrieving data functions
Properties
Name Type Attributes Default Description conditionsArray.<Condition> <optional> [] Conditions property is the name of the property in the result object (not field names)
-
ResultObject
-
Description
Generic result object for interface methods (1## - 699 ok results, 7##-899 functional fail, 9##-999 Exceptions)
Properties
Name Type Attributes Description resultCodenumber resultMessagestring exceptionObject <optional> relatedIdsys_id -
RecordWatchQueries
-
Properties
Name Type Attributes Description sn_customerservice_case_normalstring <optional> change_requeststring <optional> incidentstring <optional> x_kpn2_comp_complaintstring <optional> sc_req_itemstring <optional> incident_alertstring <optional> sysapproval_approverstring sys_user_delegatestring -
ApplicationConfiguration
-
Properties
Name Type Attributes Default Description maximumAttachmentSizenumber <optional> 100 Maximum attachment size we are able to handle
enableAdobeTaggingboolean <optional> false Use Adobe Tagging events (or not)
enableChatboolean <optional> false Whether to use the Chat UI popin
chatPopinUrlstring Script to include for chat popin
userUserConfiguration companyCompanyConfiguration uiMessagesObject Object with key: message of all known translations
versionstring mkzHeaderArray.<MenuItem> adobeObjectAdobeObject recordWatchQueriesRecordWatchQueries -
PortalFeedback
-
Properties
Name Type Description messagestring Feedback message provided
pageIdstring Page id that feeback was created on
rating'1' | '2' | '3' 1 bad, 2 neutral, 3 good
-
AdobeUserEvent
-
Properties
Name Type Description namestring Name of the event
modulestring Name of the module
positionstring Position of the interacted element
elementstring Element name
assetstring Name of the asset involved
labelstring Label to use for the interaction event
-
AdobeComponentEvent
-
Properties
Name Type Description idstring An ID that can be used to identify a specific component. This can be provided by the CMS
componentNamestring The component name of the component category. For example, this could be the title of a piece of media content, A funnel name would be: checkout, registration, sign-up A banner component type would have: internet, sale, black friday
timestampstring primaryCategorystring subCategorystring positionstring stepNamestring stepStagestring flowFunnelNamestring -
InterActionType
-
Properties
Name Type Description eventNamestring moduleNamestring positionstring elementstring (id or name)
assetNamestring (imgae, button or specific identifier for the click)
labelstring -
AdobeObject
-
Properties
Name Type Description krnIdstring krn-id of the user's company
gripIdstring grip-id of the user (when available)
sysIdstring sys-id of the user
zmCustomerType'LCE' Busines market segment
type'signed-in' | 'guest' Type/state of the user
instanceNamestring ServiceNow instance name (first part hostname)
scriptUrlstring Adobe script to include (depends on environment we are on)
profileInfoProfileInfo User profile info, send to adobe
pageNameMappingObject -
Page
-
Properties
Name Type Description urlstring -
AngularTemplate
-
Properties
Name Type Description idstring templatestring -
Link
-
Properties
Name Type Attributes Default Description displayValuestring keyValuestring urlstring <optional> urlTargetstring <optional> '_blank' pageIdstring <optional> -
MenuItem
-
Properties
Name Type Attributes Default Description labelstring Display label, will be translated during retrieval in the current language(KPN_SSP_MENU_xxxx)
iconstring Icon to use (without SI, UI or anything)
pageIdstring <optional> Page Id to got to, either this or url is required
urlstring <optional> Action to perform, usually the id in uri form
urlTargetstring <optional> '_self' Where to load the new page _self, _blank etc
activeboolean Whether the menu item is active or not (defaults to Home)
section'top' | 'bottom' The location to place the menu item, allows a single item list for multiple menu sections or locations
ordernumber In which order to sort the menu items
badgenumber When assigned a badge is included with the menu (-1, disables)
-
CompanyConfiguration
-
Properties
Name Type Description sysIdsys_id Unique record identifier
namestring Company name
krnIdstring KRN
hasKnowledgeManagementboolean If the company has Knowledge on the portal
hasIncidentmanagementboolean If the company has Incident management on the portal
hasRequestFulfillmentboolean If the company has Requests on the portal
officeHoursObject Name Type Description nlstring enstring telephoneObject Name Type Description nlstring enstring -
UserType
-
-
UserConfiguration
-
Properties
Name Type Description firstnamestring User first name
lastnamestring User last name
namestring User full name
usernamestring User identifier name
userSysIdsys_id User record identifier
gripIdstring Grip identifier
emailstring Email address
companySysIdsys_id Company record identifier
hasWorkUIboolean Work UI availble for this user
hasApprovalsboolean hasCompanyTicketViewerboolean hasCompanyTicketCommentboolean hasMkzHeaderboolean Do we expect this to be a MKZ user (best guess)
hasCsmboolean Is the user part of a CSM company
languageLanguageType Language tag
domainstring Domain?
lastLoginstring When did the user last login
locationSysIdstring Record identifier for location
isKpnboolean Is this a KPN user
countRequestedApprovalsnumber Number of approvals waiting for approval
itemsPerPagenumber Preferred number of items per page
ticketHistorynumber Number of months of ticket history to retrieve on initial load
reloadPortalboolean Reload the portal from client if a session variable is changed
showPolarisDialogboolean Whether or not to show the polaris dialog, by default set to true just in case....
-
LanguageType
-
-
IncidentDestinationFieldType
-
-
IncidentType
-
-
ImpactUrgencyType
-
Properties
Name Type Attributes Default Description impactnumber <optional> 3 urgencynumber <optional> 3 incidentImpactUrgencyObjectType Details for @IncidentType incident
rfiImpactUrgencyObjectType Details for @IncidentType rfi
-
ErrorObject
-
Properties
Name Type Description codenumber Numeric code identifying the message
messagestring Descriptive message of the Error
innerExceptionError Root cause exception that caused the message
-
ListItemType
-
Description
List item type definitions, identification of the type the item's key point to, eg for the data part it defines the item object if it is provided on the ui part it defines what components should be used for display or actions based ont he listitem selection. none - Undefined item article - Knowledge article for direct links to articles topic - Incident Form definition for direct links to topic forms request - Catalog request or cart item ticket - Any item that referes to a ticket that can be seen on the status page case - A CSM case that can be seen on the cases status page
-
ListItemItemType
-
Description
List item Item type, defines the included data in a List item, none if no item is included, list if only partial data is included, item if the full item is included
-
ListItem
-
Description
ListItem object is used in all list retrievals where we need to dislay some item and finally select one for getting more details. For enhanced use the item should include the actual item with all details to be able to use advanced client-side filtering and searching. This includes number, categoryKey and all fields to filter on. This will also require that all Objects per type have some generic way of naming properties
Properties
Name Type Attributes Default Description displayValuestring Label that is display to the end-user
keyValuestring Key that is selected as value for identification
iconstring <optional> '' Icon from the KPN set to use (without si- ui- etc)
hintstring <optional> '' Hint text to display for instance when hovered or secondline, depending on the ListItems use
itemObject <optional> The actual item, used only in special use cases, for filtering on additional fields etc.
scorenumber <optional> 0 Scoring of items within the list (page view) to indicate search relevance if available
categoryKeystring <optional> '' Category key if available
categoryLabelstring <optional> '' Category label
numberstring <optional> '' Optional
typeListItemType <optional> 'none' ListItem model type, used to determine methods and pages that match the list item
isReadonlyboolean <optional> false Whether the item is not displayed for editing or not
itemTypeListItemItemType What data is included in the item property
loadingboolean <optional> false Whether we are awaiting an update
updatedOnstring Date of the last change
-
CategoryTreeItem
-
Description
Recursive object for keeping a nested category tree
Properties
Name Type Attributes Description displayValuestring Label to display to the user
keyValuestring Key value used as reference
parentKeystring <optional> Optional parent identifier
collapsedboolean <optional> View property to keep track of open/collapse status
childrenArray.<CategoryTreeItem> -
ListItemPage
-
Description
Combined data for a list item page, that includes search, paging, listitems and categories
Properties
Name Type Attributes Default Description itemListArray.<ListItem> categoryListArray.<CategoryTreeItem> pagenumber <optional> 0 numberOfPagesnumber <optional> -1 itemsPerPagenumber <optional> -1 searchValuestring <optional> '' categoryKeystring <optional> '' totalItemCountnumber <optional> 0 exceptionObject <optional> typeListItemType Type of the list item, to aid in assessing what to do with one
filterFilterOptions <optional> Future change, so we can reduce the number of properties in the root +
-
IncidentTopic
-
Properties
Name Type Description sysIdsys_id contentstring topicBasestring incidentTypeIncidentType categoryKeystring languageLanguageType shortDescriptionstring metastring recordProducersys_id assignGroupFromPortfolioboolean relatedKnowledgeArray.<ListItem> questionListArray.<TopicQuestion> -
TopicQuestion
-
Description
Generic question type that allows for providing input and creating form elements
Properties
Name Type Attributes Default Description keyValuesys_id SysId or other keyvalue of the highest question definitino
contentstring <optional> Html content
hintstring <optional> Hint explaining the answer options for this question
displayValuestring Label or question text
mandatoryboolean Whether a value is mandatory for this question
ordernumber Order of the question in the full set of questions
choicesArray.<Choice> Possible answer options for a restricted set
methodstring Function name on the SSP interface that could provide a list of choices
labelstring @deprecated
languageLanguageType @deprecated
namestring typeQuestionType validationstring -
QuestionType
-
-
TopicQuestionType
-
-
QuestionDisplayType
-
Description
Future proof Form elements
-
FilterCondition
-
Description
TODO: Think about FilterCondition, will it work, before we actually apply
Properties
Name Type Description propertystring Property on the Object item to validate against
operatorstring The comparison operator that matches the value in a certain way
valueObject The valu to validate/match agsainst
{ 'start', '>=', '2023-11-12'} { 'start', 'STARTSWITH', '2023-11-12'} { 'affectedUser', 'STARTSWITH', 'Ritima'}
-
Attachment
-
Properties
Name Type Attributes Description sysIdsys_id filenamestring contentTypestring sizenumber thumbnailstring updatedOnstring datastring <optional> -
KnowledgeArticle
-
Properties
Name Type Attributes Default Description keyValuesys_id numberstring <optional> '' categoryCategoryTreeItem <optional> displayValuestring descriptionstring metastring contentstring languageLanguageType parentSysIdsys_id publishedstring versionstring incidentTopicsys_id viewCountnumber pinnedboolean -
RecordReference
-
Properties
Name Type Description sysIdsys_id displayValuestring -
Breadcrumb
-
Properties
Name Type Description labelstring searchObject -
SortOrder
-
-
OrderBy
-
Properties
Name Type Description ordernumber propertystring sortOrderSortOrder -
FilterOptions
-
Properties
Name Type Attributes Default Description searchValuestring <optional> '' queryObjectObject <optional> Object that has all the form properties/values that cn be used to restrict lookup queruies further
conditionsArray.<FilterCondition> <optional> [] Future use for additional selectable field values that are not generic in nature
pagenumber <optional> -1 itemsPerPagenumber <optional> -1 orderByArray.<OrderBy> categorystring <optional> '' Selected category or empty string for none
Example queryobject
obj.task_for = ListItem object (keyValue=sysId) obj.sold_product = ListItem object (keyValue=sysId) obj.install_base = ListItem object (keyValue=sysId)
-
StatusItem
-
Description
Object used on status table list
Properties
Name Type Attributes Default Description createdstring updatedstring typeTicketType displayValuestring numberstring statusTicketStatus Generic status
actualStatusstring customerReferencestring <optional> '' Details
-
StatusPageView
-
Description
Ensure property names are kept equal to regular PageView
Properties
Name Type Description itemListArray.<ListItem> List of items retrieved based on filter settings (includes pagination)
totalItemCountnumber Total items in query set
filterFilterOptions Filter that is used to create the list
-
Ticket
-
Description
Object display on status detail page
Properties
Name Type Attributes Default Description keyValuesys_id numberstring <optional> '' Unique ticket number
actionstring <optional> '' customerReferencestring Reference provided by the customer
displayValuestring Description (short) of the ticket
descriptionstring Description (long) of the ticket (for case this can be HTML)
functionalStateTicketStatus Functional mapped status
functionalSubstatestring typeTicketType resolutionstring requesterstring // Map reportedBy to requester
affectedUserstring Display name of the affected user
createdOnstring Must be replaced with a normal date time value for the creation
updatedOnstring Must be replaced with a normal date time value for the update
resolvedOnstring When is the status changed to a resolved type state (eg the situation is resolved)
commentsArray.<DocumentComment> attachmentsArray.<Attachment> servicestring Service or product involved
installBasestring canPostboolean Whether the current user is allowed to post comments or not (company viewer)
canUploadboolean Whether the current user is allowed to upload attachements (company viewer)
isOwnTicketboolean Whether the current user is ticket owner
plannedStartDatestring when is the work expected to start
plannedEndDatestring when is the work expected to end
propertiesArray.<Property> List of additional properties that can be displayed on a status page oor provide additional useful information
-
DocumentComment
-
Description
Document Comment object
Properties
Name Type Attributes Description documentIdsys_id Parent comment sys_id
typeTicketType <optional> commentstring createdBystring <optional> Display name of the user created the comment
createdOnstring <optional> Date the comment was added
-
RequestType
-
-
Request
-
Description
Request object
Properties
Name Type Description keyValuesys_id displayValuestring typeRequestType -
MenuState
-
-
SearchLocation
-
Properties
Name Type Attributes Default Description idstring Page identifier
cstring <optional> Category key
sstring <optional> Search value
istring <optional> Selected item
-
ApplicationState
-
Description
State object, object that maintains values application wide so that multiple widgets can use it
Properties
Name Type Attributes Default Description contextstring showDetailboolean showDetailLoadingboolean showListboolean showListLoadingboolean showErrorboolean errorMessagestring selectedItemKeystring selectedCategoryNamestring selectedCategoryKeystring searchValuestring handlingEventboolean fetchingDataboolean loadingboolean Whether the application state is in loading (initial) state or loaded after we retrieved the data
appAppState targetSearchLocation previousTargetSearchLocation menuStateMenuState breadcrumbsArray.<Breadcrumb> <optional> [] enableAdobeTaggingboolean <optional> false homePageState knowledgePageState incidentPageState requestPageState complaintPageState statusPageState delegatesPageState approvalsPageState casePageState -
StateValuesEnum
-
-
StateValues
-
Properties
Name Type Description Breadcrumbs'breadcrumbs' SearchValue'searchValue' PageNumber'pageNumber' ViewData'viewData' SelectedCategory'selectedCategory' SelectedItem'selectedItem' ApplicationConfig'appConfig' MenuItem'menuItem' -
NotificationDetails
-
Parameters
Name Type Description inputObject Not used in this scenario
Properties
Name Type Description pendingApprovalsnumber Number of pending approvals
pendingTicketsnumber Number of tickers waiting for user input
Get user notification details, for instance pending item tasks
Returns
-
ActionEnum
-
-
ActionResult
-
Properties
Name Type Description stateApplicationState actionActionEnum result;Object -
ViewEvent
-
Properties
Name Type Description ApplicationInit'ssp_view_applicationInit' SearchChange'ssp_view_searchChange' SearchClick'ssp_view_searchClick' CategoryClick'ssp_view_categoryClick' ListItemClick'ssp_view_listItemClick' FormFieldChange'ssp_view_formFieldChange' FormSubmitClick'ssp_view_formSubmitClick' FormLookup'ssp_view_formLookup' BreadcrumbClick'ssp_view_breadcrumbClick' MenuItemClick'ssp_view_menuItemClick' PageNumberClick'ssp_view_pageNumberClick' PageLinkClick'ssp_view_pageLinkClick' SortIconClick'ssp_view_sortIconClick' FilterChange'ssp_view_filterChange' ExternalLinkClick'ssp_view_externalLinkClick' ActionItemClick'ssp_view_actionItemClick' -
Action
-
Description
Action object that defines an action where the value is the source or target element (depending the action type)
Properties
Name Type Description type'follow_ticket' | 'create_incident_child' valueObject -
Choice
-
Description
Choice item for selecting keyvaluse with only a display/label value
Properties
Name Type Attributes Description keyValuestring displayValuestring valueany <optional> Optionally value (used for check box selections)
-
Property
-
Description
Property object that encapsulate a property, source and value
Properties
Name Type Attributes Default Description keyValuesys_id sys_id of the property in the source
sourcestring <optional> '' Source where the value is defined
propertystring valuestring Original source value
displayValuestring Label or display value (translated when needed?)
-
FormDefinition
-
Properties
Name Type Attributes Default Description formIdstring Unique identifier of a form in the complete client application, pref. name like for tagging purposes
titlestring Title to display above the form
contentstring <optional> '' content to show between title and form fields
submitLabelstring <optional> 'Submit' cancelLabelstring <optional> 'Cancel' resetLabelstring <optional> 'Reset' hasResetButtonboolean <optional> false Whether we allow form reset
hasCancelButtonboolean <optional> false Whether we a cancel button (that closes the form and back to previous)
fieldListArray.<FormField> A list of fields to show on the form
sectionListArray.<FormSection> <optional> [] Sections to group fields by
afterSubmission'none' | 'widget' | 'message' <optional> 'message' Action to take after submission, related value has widget if needed
afterSubmissionValuestring <optional> submitMethodstring RequestObject method to call when submitting the form
sourceIdsys_id <optional> Sys_id of the article that was the starting point or this topic
relatedKnowledgeArray.<ListItem> function"new" | "edit" <optional> "edit" Form function, used in ensuring fields
tablestring <optional> '' When updating an existing item this reflect the source table of the item
documentIdsys_id <optional> '' When updating an existing item this reflect the source document in [table]
-
FormResponse
-
Properties
Name Type Attributes Description formIdstring titlestring messagestring contentstring itemObject <optional> Created item
successboolean -
FormField
-
Description
text - simple one line text field html - html field dropdown - selection combo with pre-defined choices list - select list with pre-defined choices lookup - selection combo with a back-end lookup function to search checkbox - simple checkbox with on/true and off/false textarea - multi line text input radio - multi switch using a radio button group, only a single value can be selected multilist - watchlist like field, where you can type a value and add it to the value set (and remove)
Properties
Name Type Attributes Default Description labelstring Display label
idstring <optional> name Unique identifier within the form
namestring Unique name within the form
propertystring Property or table field to store the value when submitting
valuestring | Array.<string> | Object <optional> defaultValue Value default or changed by user
defaultValuestring | Array.<string> | Object Default value on start/reset
typeFormFieldType Type of input element to display
valueFormatstring <optional> '' Format that value must be provided in (eg date/time format)
choiceListArray.<ListItem> <optional> [] List of choices for selectable fields (checkbox, radio, list, combo, lookup)
choiceMethodstring <optional> '' c_SSPInterface function for retrieving choices as listitem provided with optional filter (*searched lookup)
hintstring <optional> '' hint to explain field or function
contentstring <optional> '' content to always show above field and label
placeholderstring <optional> '' placeholder to show inside field
validationObject To be determined later, way of validing field before submission
isMandatoryboolean <optional> false Whether the field is mandatory to submit form
isReadOnlyboolean <optional> false Whether the field is readonly (Only value is used)
sectionIdstring <optional> '' Section id if applicable to show field on
ordernumber Unique number to sort fields in sections and forms
isValidboolean <optional> true validationMessagestring <optional> '' columns'1' | '2' | '3' <optional> '2' Number of columns on a 'md' size display or larger, smaller screen sizes will adjust
reloadFormboolean <optional> false When set a change to this field will trigger a reload form
-
FormSection
-
Properties
Name Type Attributes Default Description sectionIdstring Unique section
labelstring Label above section
contentstring <optional> '' Content to show above fields, below label
isCollapsibleboolean <optional> false Whether the section can be collapsed or not
isCollapsedboolean <optional> false Whether the section is collapsed
-
RequestObject
-
Properties
Name Type Attributes Description keystring Unique request key
prioritynumber Set the priority, lower is more important
referencestring Reference for the request content
methodstring Method to call on the REST API
inputRequestObjectInput Input parameter object
outputRequestObjectOutput Output (response data) object
statusLoadingState exceptionError Caught error, expected when output == undefined
retryCountnumber retrievedboolean loadingboolean creatednumber Date() when the request was created
requestednumber <optional> receivednumber <optional> Date() when the response was received
callbackfunction Callback function that handles the processing of request/request output
useBackgroundboolean Try to use a background worker for this request
-
RequestObjectOutput
-
Properties
Name Type Description categorystring searchValuestring itemsPerPagenumber pagenumber categoryKeystring categoryListCategoryTreeItem inputRequestObjectInput itemListArray.<ListItem> itemsPerPagenumber numberOfPagesnumber pagenumber searchValuestring totalItemCountnumber typestring -
RequestQuestion
-
Delegate
-
Properties
Name Type Description keyValuesys_id sys_id of the delegate record if existing otherwise null
userstring Name of the user that is beging delegate to somelese
typeListItemType Type so that the client knows how to show this
delegatestring Name of the user that is delegate for the user
delegateSysIdsys_id sys_id of the delegate
startsstring start date and time
endsstring end date and time
approvalsboolean if approvals are delegated, other options are set to defaults
isOwnDelegateboolean Whether this current user delegates to someone else
-
Approval
-
Properties
Name Type Description keyValuesys_id displayValuestring documentIdsys_id documentDisplayValuestring documentListItem typeListItemType stateApprovalState updatedOnstring commentsArray.<DocumentComment> -
ReferenceField
-
Properties
Name Type Attributes Default Description sys_idsys_id namestring numberstring <optional> '' -
DelegateRecord
-
Properties
Name Type Description sys_idsys_id Delegate record id
userReferenceField User that is delegated
delegateReferenceField User that is delegated to
startsstring When the delegation starts
endsstring When the delegation ends
assignmentsboolean If assisgments are delegated
approvalsboolean If approvals are delegated
notificationsboolean If notifications are delegated
invitationsboolean If invitations are delegated
-
SurveyResponse
-
Description
Object definitions with information that the client app or user will see or use Table query: asmt_assessment_instance + asmt_metric_type ==> publish_state=published^active=true
Properties
Name Type Attributes Default Description keyValuestring sys_id of instance
displayValuestring label (not part of assessment)
sourcestring Depends on source_table and provides an indication where this survey can be displayed
introductionstring HTML introduction to the survey
urlstring URL to return the user to after the survey is completed (not used on portal, we take care of that part)
categoriesArray.<SurveyCategory> <optional> When used, questions are seperated by categories
questionsArray.<SurveyQuestion> <optional> [] List of questions available in this category or directly on the survey if no categories are used
valueObject methodstring Function to use on c_SSPInterface to submit Survey changes
Survey Category to divide questions into sections
namestring Name and identifier of the category
contentstring Optional (html) content
ordernumber Sorting by
questionsArray.<SurveyQuestion> If using categories, the question will be under the category
Table query: asmt_assessment_instance_question + asmt_metric + asmt_template(_definition)
keyValuestring sys_id of instanc_question
displayValuestring Question to ask (translated)
conditionCondition Condition to make this question available/visible/mandatory etc, first instance only visible or not (will indirect change required to false if not visible)
typeSurveyDataType Question type, indication of the required value
optionsSurveyTypeOptions Additional options related to type
initialValuestring If there is a default value, this is what we will start with
requiredboolean Is providing an answer/value required (mandatory)
validationsArray.<SurveyValidation> Optional validations for value
categorystring <optional> '' Sub division by category or section
ordernumber Sorting value to order questions
Additional options to help detailing the display and value specification for questions
stringOptions'short' | 'wide' | 'multiline' Define specifics for the string type
choicesArray.<SurveyChoice> For various types there is a choice list
lookupstring When we have a reference field or lookup field, this method is used to query for options/choices, when using a choice with a reference_table, this is a generic method
A as generic as possible condition object, the source for condition will always be a value object that can be nested in layers
propertystring Property to match
valuestring | Array.<string> Value or range of value to match with
typeComparisonboolean <optional> false Whether to include type in comparison (=== vs ==)
comperator'>=' | '>' | '=' | '<' | '<=' | '!' <optional> '=' How to compare the provided value against the target (target = value)
Choice objects that define restricted answers to a question
keyValuestring Identifier and value selector for this choice
displayValuestring Display value (translated)
selectedImagestring A url to an image to use when not selected
unselectedImagestring A url to an image to use when selected
showLabelboolean Whether to display the label or not (for instance images only )
showImageboolean Whether to display images or not
Define value validations
minimumnumber | undefined <optional> Minimum value for numeric fields, undefined if not to be used
maximumnumber | undefined <optional> Maximum value for numeric fields, undefined if not to be used
minimumLengthnumber | undefined <optional> Minimum length for a string field
maximumLengthnumber | undefined <optional> Maximum length for a string field
regexArray.<string> <optional> [] Regular expressions to match
Define the response once the Survey has been submitted
-
GroupConfig
-
Properties
Name Type Description supportGroupObject Name Type Description idstring namestring serviceDeskObject Name Type Description idstring namestring