QueryContainerDTO

Container that holds the query to execute.

Fields

Type
Name
Description
Optional
Default Value
IQueryDTO  
query
The query to execute.
false
 
ResultConfigDTO  
config
The configuration for the json result representation.
true
 

Example

{
	"query": {
		"_type": "PLAINKEY",
		"searchOrderBy": [
			{
				"field": "<fieldNameToSortBy>",
				"sort": "DESCENDING"
			}
		],
		"viewOrderBy": null,
		"useDistinct": null,
		"topCount": null,
		"parameters": [
			{
				"_type": "String",
				"value": "Hello World!",
				"writable": true,
				"readable": true,
				"status": null
			},
			{
				"_type": "Lookup",
				"value": {
					"pk": "S_ACTTYPE-ME",
					"key": "MAILEIN",
					"description": "Incoming Mail",
					"symbol": {
						"type": "NONE"
					}
				},
				"writable": true,
				"readable": true,
				"status": null
			}
		],
		"rawParameters": null,
		"parameterMap": null,
		"plainkey": "MyActivities",
		"ignoreUseCost": false,
		"luceneCondition": null
	},
	"config": {
		"resultType": "JSON",
		"fieldType": "RESULT_FIELDS",
		"additionalFields": [
			"Subject.Activity",
			"StartDate.Activity"
		],
		"columnInfoType": "BASIC",
		"displayNameType": "NONE",
		"additionalDisplayNameFields": [
			"Pk.Activity",
			"Active.Activity"
		],
		"includeBase64ImageValues": true,
		"resolveDisplayNameFromWorkspaceSearch": false
	}
}