ResultConfigDTO

Configuration object to define the representation result data container.

IMPORTANT: Fields of type RecordableListView are currently not supported by RestAPI!

Fields

Type
Name
Description
Optional
Default Value
ResultType  
resultType
The representation of the entries in the result data container.
true
JSON
FieldConfigType  
fieldType
Preset of fields that should be included in the result.
true
RESULT_FIELDS
List
String
additionalFields
List of fields that will be added to chosen 'fieldType' preset.
true
null
ColumnInfoType  
columnInfoType
The configuration of the column information contained in the result.
true
BASIC
FieldConfigType  
displayNameType
Preset of fields that should be used to generate a display name for the entries.
true
NONE
List
String
additionalDisplayNameFields
List of fields that will be added to chosen 'displayNameType' preset.
true
null
Boolean  
includeBase64ImageValues
Flag to control if base64 image values should be included in AttributeContainer. If falseonly MD5 checksum will be set and images need to be loaded separately.
true
true
Boolean  
resolveDisplayNameFromWorkspaceSearch
Flag to control if the display name should be resolved by using the search instead of the workspace configuration (if possible).
true
false

Example

{
	"resultType" : "JSON",
	"fieldType" : "RESULT_FIELDS",
	"additionalFields" : [
		"Subject.Activity",
		"StartDate.Activity"
	],
	"columnInfoType" : "BASIC",
	"displayNameType" : "NONE",
	"additionalDisplayNameFields" : [
		"Pk.Activity",
		"Active.Activity"
	],
	"includeBase64ImageValues" : true,
	"resolveDisplayNameFromWorkspaceSearch" : false
}