SearchByPlainkeyQueryDTO

QueryDTO to execute a search by plainkey.

Sub Type Property: "_type" : "PLAINKEY"

Fields

Type
Name
Description
Optional
Default Value
String  
plainkey
The search plainkey.
false
 
Boolean  
ignoreUseCost
Flag to ignore the useCost check of the search.
true
true
LuceneConditionDTO  
luceneCondition
The lucene condition of the search.
true
null
List
AbstractAttributeValueDTO
parameters
The parameter values, which will be applied to parameter templates of the search in the given order.
true
null
List
SearchOrderEntryDTO
searchOrderBy
Definition of how the server side search result will be sorted.
true
null
List
SearchOrderEntryDTO
viewOrderBy
Definition of how the view of the result will be sorted.
true
null
Boolean  
useDistinct
Flag to enable/disable a distinct search.
true
false

Example

{
	"_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
}