alfresco-js-api

# AlfrescoContentServicesRestApi.SearchApi All URIs are relative to *https://localhost/alfresco/api/-default-/public/search/versions/1* Method | HTTP request | Description ------------- | ------------- | ------------- [**search**](SearchApi.md#search) | **POST** /search | Searches Alfresco <a name="search"></a> # **search** > ResultSetPaging search(queryBody) Searches Alfresco ### Example ```javascript this.alfrescoJsApi.search.searchApi.search({ "query": { "query": "select * from cmis:folder", "language": "cmis" } }).then(function (data) { console.log(data); }, function (error) { console.error(error); }); ``` ### Node js Example ```javascript var AlfrescoApi = require('alfresco-js-api'); this.alfrescoJsApi = new AlfrescoApi(); var self = this; this.alfrescoJsApi.login('admin', 'admin').then(function (data) { console.log('API called successfully Login ticket:' + data); self.alfrescoJsApi.search.searchApi.search({ "query": { "query": "select * from cmis:folder", "language": "cmis" } }).then(function (data) { console.log(data); }, function (error) { console.error(error); }); }, function (error) { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queryBody** | [**QueryBody**](QueryBody.md)| Generic query API | ### Return type [**ResultSetPaging**](ResultSetPaging.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <div class="content" id="search_search_content" style="display: block;"> <h4>Implementation Notes</h4> <div class="markdown">Note: this endpoint is available in Alfresco 5.2 and newer versions. You specify all the parameters in this API in a JSON body, URL parameters are not supported. A basic query looks like this: <pre><code class="lang-JSON json">{ "query": { "query": "foo" } } </code></pre> Note: These are the minimum possible query parameters. The default search language is afts (<a href="http://docs.alfresco.com/5.1/concepts/rm-searchsyntax-intro.html">Alfresco Full Text Search</a>), but you can also specify cmis, and lucene. A basic CMIS query looks like this: <pre><code class="lang-JSON json">{ "query": { "query": "select * from cmis:folder", "language": "cmis" } } </code></pre> By default, results are limited to the first 100. Results can be restricted using "paging". For example: <pre><code class="lang-JSON undefined">"paging": { "maxItems": "50", "skipCount": "28" } </code></pre> This example would ensure that results are limited by Final Size, skipping the first 28 results and returning the next 50. Alternatively, you can limit the results by using the limits JSON body parameter. For example, <pre><code class="lang-JSON undefined">"limits": { "permissionEvaluationTime": 20000, "permissionEvaluationCount": 2000 } </code></pre> The default search uses workspace://SpacesStore. To change the scope to a particular store you can use the scope JSON body parameter. For example, <pre><code class="lang-JSON undefined">"scope": { "stores": ["archive://SpacesStore", "workspace://SpacesStore"] } </code></pre> You can use the include JSON body parameter to return additional information. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: <pre><code class="lang-JSON undefined">"include": ["aspectNames", "properties", "isLink"] </code></pre> You can use the fields JSON body parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: <pre><code class="lang-JSON undefined">"fields": ["id", "name", "search"] </code></pre> You can sort the results using the sort JSON body parameter, for example: <pre><code class="lang-JSON undefined">"sort": [{"type":"FIELD", "field":"cm:description", "ascending":"true"}] </code></pre> Note: the sort parameter is not supported for CMIS queries. You can specify templates using the templates JSON body parameter, for example: <pre><code class="lang-JSON undefined">"templates": [{"name": "_PERSON","template": "|%firstName OR |%lastName OR |%userName"}, {"name": "mytemplate","template": "%cm:content"}] </code></pre> For spell checking you can use a query like this: <pre><code class="lang-JSON json">{ "query": { "query": "cm:title:alfrezco", "language": "afts" }, "spellcheck": {"query": "alfrezco"} } </code></pre> If you are already specifying "userQuery" then the following may be easier and produces the same result : <pre><code class="lang-JSON json">{ "query": { "query": "cm:title:alfrezco", "userQuery": "alfrezco", "language": "afts" }, "spellcheck": {} } </code></pre> The spellcheck response includes a spellCheck context like this: <pre><code class="lang-JSON undefined">"context": { "spellCheck": { "type": "searchInsteadFor", "suggestions": ["alfresco"] } }, </code></pre> To specify defaults, you use a defaults JSON body parameter, for example: <pre><code class="lang-JSON undefined">"defaults": { "textAttributes": [ "cm:content", "cm:name" ], "defaultFTSOperator": "AND", "defaultFTSFieldOperator": "OR", "namespace": "cm", "defaultFieldName": "PATH" } </code></pre> You can specify several filter queries using the filterQueries JSON body parameter, for example: <pre><code class="lang-JSON undefined">"filterQueries": [{"query": "TYPE:'cm:folder'"},{"query": "cm:creator:mjackson"}] </code></pre> You can specify several facet queries using the facetQueries JSON body parameter, for example: <pre><code class="lang-JSON undefined">"facetQueries": [{"query": "created:2016","label": "CreatedThisYear"}] </code></pre> The response will contain a matching "context" section, the "label" will match the facet query. <pre><code class="lang-JSON undefined">"context": { "facetQueries": [ {"label": "CreatedThisYear","count": 3} ] }, </code></pre> A complete query for facetting via the content.size field looks this: <pre><code class="lang-JSON json">{ "query": { "query": "presentation", "language": "afts" }, "facetQueries": [ {"query": "content.size:[0 TO 10240]", "label": "xtra small"}, {"query": "content.size:[10240 TO 102400]", "label": "small"}, {"query": "content.size:[102400 TO 1048576]", "label": "medium"}, {"query": "content.size:[1048576 TO 16777216]", "label": "large"}, {"query": "content.size:[16777216 TO 134217728]", "label": "xtra large"}, {"query": "content.size:[134217728 TO MAX]", "label": "XX large"} ], "facetFields": {"facets": [{"field": "'content.size'"}]} } </code></pre> The response will contain a matching "context" section, the "label" will match the facet query. <pre><code class="lang-JSON undefined">"context": { "facetQueries": [ { "label": "small","count": 2 }, { "label": "large","count": 0 }, { "label": "xtra small","count": 5 }, { "label": "xtra large","count": 56}, { "label": "medium","count": 4 }, { "label": "XX large", "count": 1 } ] }, </code></pre> You can specify several facet fields using the facetFields JSON body parameter, for example: <pre><code class="lang-JSON undefined">"facetFields": {"facets": [{"field": "creator", "mincount": 1}, {"field": "modifier", "mincount": 1}]} </code></pre> The response will contain a matching "context" section, the "label" will match the facet field. <pre><code class="lang-JSON undefined">"context": { "facetsFields": [ { "label": "creator", "buckets": [ { "label": "System", "count": 75 }, { "label": "mjackson", "count": 5 } ]}, { "label": "modifier", "buckets": [ { "label": "System", "count": 72 }, { "label": "mjackson", "count": 5 }, { "label": "admin", "count": 3 } ]} ] }, </code></pre> An example query for search highlighting could look like this: <pre><code class="lang-JSON json">{ "query": { "query": "description:workflow", "userQuery":"workflow" }, "highlight": { "prefix": "¿", "postfix": "?", "mergeContiguous": true, "fields": [ { "field": "cm:title" }, { "field": "description", "prefix": "(", "postfix": ")" } ] } } </code></pre> The example above changes the highlighting prefix and postfix from the default for all fields to ¿? and just for the "description" field to (). The hightlight information is added in each node entry response; here is an example partial response: <pre><code class="undefined">"entry": { "createdAt": "2016-10-12T15:24:31.202+0000", "isFolder": true, "search": { "score": 1, "highlight": [ { "field": "cm:title", "snippets": [ "Customized ¿Workflow? Process Definitions" ] }, { "field": "description", "snippets": [ "Customized (Workflow) Process Definitions" ] } ] }, </code></pre>