 |
Index of Web Scripts Package '/org/alfresco/repository/search' |
| Alfresco Community v3.2.0 (2039) |
| 7 Web Scripts |
| Back to Web Scripts Home |
| Up to package /org/alfresco/repository |
Alfresco Keyword Search (OpenSearch Enabled)
| Description: | Execute Keyword Search against Alfresco Repository (Company Home and below) |
| Authentication: | guest |
| Transaction: | required |
| Format Style: | any |
| Default Format: | html |
| Id: | org/alfresco/repository/search/keywordsearch.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/search/keywordsearch.get.desc.xml |
Keyword Search Description
| GET /alfresco/service/api/search/keyword/description.xml |
| GET /alfresco/service/search/keyword/description.xml |
| Description: | OpenSearch description document for Alfresco Repository keyword search |
| Authentication: | none |
| Transaction: | none |
| Format Style: | argument |
| Default Format: | opensearchdescription |
| Id: | org/alfresco/repository/search/keywordsearchdescription.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/search/keywordsearchdescription.get.desc.xml |
Alfresco Person Search (OpenSearch Enabled)
| Description: | Execute Person Search against Alfresco Repository |
| Authentication: | guest |
| Transaction: | required |
| Format Style: | any |
| Default Format: | html |
| Id: | org/alfresco/repository/search/personsearch.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/search/personsearch.get.desc.xml |
Person Search Description
| GET /alfresco/service/api/search/person/description.xml |
| GET /alfresco/service/search/person/description.xml |
| Description: | OpenSearch description document for Alfresco Repository person search |
| Authentication: | none |
| Transaction: | none |
| Format Style: | argument |
| Default Format: | opensearchdescription |
| Id: | org/alfresco/repository/search/personsearchdescription.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/search/personsearchdescription.get.desc.xml |
Issue ad-hoc query (query)
| POST /alfresco/service/api/query |
| Description: | Queries the repository for queryable object based on properties or an optional full-text string. Relationship objects are not queryable. Content-streams are not returned as part of query. Inputs: String statement: Query statement (Optional) Bool searchAllVersions: False (Default) (Optional) Boolean includeAllowableActions: False (default) (Optional) Enum includeRelationships: none (default), source, target, both (Optional) int maxItems: 0 = Repository-default number of items (Default) (Optional) int skipCount: 0 = Start at first position (Default) Outputs: Collection objectCollection - this collection represents a result table produced by the query statement. Typically each row of this table corresponds to an object, and each column corresponds to a property or a computed value as specified by the SELECT clause of the query statement. A CMIS SQL 1.0 query without JOIN always produces one object per row. Bool hasMoreItems Notes: If SearchAllVersions is True, and CONTAINS() is used in the query, OperationNotSupported will be thrown if full-text search is not supported or if the repository does not have previous versions in the full-text index. Returns set of objects from (skipCount, maxItems+skipCount) If no “maxItems” value is provided, then the Repository will determine an appropriate number of items to return. How the Repository determines this value is repository-specific and opaque to CMIS. If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each result object in the output table as an additional multi-valued column containing computed values of type string, provided that each row in the output table indeed corresponds to one object (which is true for a CMIS SQL 1.0 query without JOIN). If each row in the output table does not correspond to a specific object and “includeAllowableActions” is TRUE, then InvalidArgumentException will be thrown. It is recommended that “includeAllowableActions” be used with query statements without JOIN, and that the Object ID property or “*” be included in the SELECT list. "IncludeRelationships" indicates whether relationships are also returned for each returned object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned. |
| Authentication: | user |
| Transaction: | required |
| Format Style: | any |
| Default Format: | atomfeed |
| Id: | org/alfresco/repository/search/query.post |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/search/query.post.desc.xml |
Search Engines
| Description: | Lists "search engines" registered with this Alfresco Repository |
| Authentication: | none |
| Transaction: | none |
| Format Style: | any |
| Default Format: | html |
| Id: | org/alfresco/repository/search/searchengines.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/search/searchengines.get.desc.xml |
Proxied (OpenSearch) Search
| GET /alfresco/service/api/search/engine/{engine}/{format} |
| GET /alfresco/service/search/engine/{engine}/{format} |
| Description: | Search engine proxy for issuing a search against a remote search engine |
| Authentication: | none |
| Transaction: | none |
| Format Style: | any |
| Default Format: | Determined at run-time |
| Id: | org/alfresco/repository/search/searchproxy.get |
| Description: | classpath:alfresco/templates/webscripts/org/alfresco/repository/search/searchproxy.get.desc.xml |