Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This object is used for search element in wordbee.

Warning

Deprecated. Please use the query mechanisms described here: resources/segments/search



Table of Contents

 


STRUCTURE

Code Block
{
 "filters":[], // Contain list of filter for limit results
 "locale":"en-GB", // locale apply on filters
 "sorts":[], // Allow to organize results
 "take":5, //  Number of elements in the results
 "skip":2 // The results start at position
}

 


The message body contains a JSON object:

filters

Contain list of Filter object

localeThe locale used by filters
sorts

Contain list of Sort object

take
Number of elements
skipStart position to get elements

 


Multiple sort

You can sort by multiple ....:

Code Block
{
	"filters":[],
	"locale":"en",
	"orderby":[
		{"key":"Text","ascending":true}, // Sort results by Text ascending
		{"key":"LastModification","ascending":false} // And sort by LastModification descending
	],
	"take":25,
	"skip":0
}

...


Multiple filter

You can sort by multiple ....:

Code Block
{
	"filters":[
		{"KeywordId":"global","Value":{"value":["Test"], caseSensitive: true, exactMatch: false}}, // The segment text need to contains "Test" (Case sensitive)
		{"KeywordId":"status:","Value":{"value":["Problem"]}} // And status is "Problem"
	],
	"locale":"en",
	"orderby":[
		{"key":"Text","ascending":true}, // Sort results by Segment Id
	],
	"take":25,
	"skip":0
}

...


EXAMPLES

See this example:

...