Skip to content

Latest commit

 

History

History
47 lines (39 loc) · 3.36 KB

SearchRequest.md

File metadata and controls

47 lines (39 loc) · 3.36 KB

SearchRequest

Properties

Name Type Description Notes
query RequestQuery
paging RequestPagination [optional]
include List[str] Returns additional information about the node. The following optional fields can be requested: * properties * aspectNames * path * isLink * allowableOperations * association * isFavorite [optional]
include_request bool When true, include the original request in the response [optional] [default to False]
fields List[str] A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the include parameter is used aswell then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. [optional]
sort List[RequestSortDefinitionInner] How to sort the rows? An array of sort specifications. The array order defines the ordering precedence. [optional]
templates List[RequestTemplatesInner] Templates usewd for query expansion. A template called "WOOF" defined as "%(cm:name cm:title)" allows WOOF:example to generate cm:name:example cm:name:example [optional]
defaults RequestDefaults [optional]
localization RequestLocalization [optional]
filter_queries List[RequestFilterQueriesInner] Filter Queries. Constraints that apply to the results set but do not affect the score of each entry. [optional]
facet_queries List[RequestFacetQueriesInner] Facet queries to include [optional]
facet_fields RequestFacetFields [optional]
facet_intervals RequestFacetIntervals [optional]
pivots List[RequestPivot] [optional]
stats List[RequestStats] [optional]
spellcheck RequestSpellcheck [optional]
scope RequestScope [optional]
limits RequestLimits [optional]
highlight RequestHighlight [optional]
ranges List[RequestRange] [optional]

Example

from alfresco_search_api_client.models.search_request import SearchRequest

# TODO update the JSON string below
json = "{}"
# create an instance of SearchRequest from a JSON string
search_request_instance = SearchRequest.from_json(json)
# print the JSON string representation of the object
print SearchRequest.to_json()

# convert the object into a dict
search_request_dict = search_request_instance.to_dict()
# create an instance of SearchRequest from a dict
search_request_form_dict = search_request.from_dict(search_request_dict)

[Back to Model list] [Back to API list] [Back to README]