Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Complex Types - configOptionListType

Description

This type represents an application or system configuration option returned in a list of options.

Properties

Name Type Occurrence Description
advanced xs:boolean Optional Defines the option as being an advanced option (not generally editable by users)
choice Array<xs:string> Optional An array of possible values. If this is defined, then only one of these values are valid for the parameter.
choiceFlowcode xs:string Optional The name of a flowcode used to get the list of possible choices for this option’s value. appcode:flowcodename
choiceQuery xs:string Optional The name of a stored query to use to get the list of possible choices for this option’s value.
contentType xs:string Optional Defines the type of content stored in this option.
dataType configOptionDataType Optional Defines the data type this option supports.
defaultValue xs:string Optional The default value.
description xs:string Optional The text description for this option.
editable configOptionEditableType Optional Defines the editable status of this option
isDefault xs:boolean Required If set to true, then the value returned is the default value defined by the application out of the box.
key xs:string Required The key name.
maxInclusive xs:unsignedInt Optional If the parameter is a ‘number’ this can specify the maximum allowable value.
minInclusive xs:unsignedInt Optional If the parameter is a ‘number’ this can specify the minimum allowable value.
multiChoice Array<xs:string> Optional An array of possible values. If this is defined, then any combination of these values are valid for the parameter.
pattern xs:string Optional A RegEx pattern that this value must match in order to be valid.
patternErrorMessage xs:string Optional A message to display to the user when the provided value does not match the specified patteren.
secure xs:boolean Optional Defines the option as holding informaiton that should be treated as secure.
value xs:string Optional The value.
In This Document