You are here

GET Faceted-Search Config

Get faceted-search config, if configured http://
GET /alfresco/service/api/facet/facet-config
GET /alfresco/service/api/facet/facet-config/{filterID}
        
      <host>:<port>/alfresco/api/facet/facet-config
   Or
   http://<host>:<port>/alfresco/api/facet/facet-config/{filterId}
   Example response from this web script:
   {
    "facets": [
          {
             "filterID" : "filter_content_size",
             "facetQName" : "{http://www.alfresco.org/model/content/1.0}content.size",
             "displayName" : "faceted-search.facet-menu.facet.size",
             "displayControl" : "alfresco\/search\/FacetFilters",
             "maxFilters" : 5,
             "hitThreshold" : 1,
             "minFilterValueLength" : 5,
             "sortBy" : "ALPHABETICALLY",
             "scope" : "SCOPED_SITES",
             "scopedSites" : [
                     "site3",
                     "site2",
                     "site1"
              ],
             "customProperties" :
             {
                "blockIncludeFacetRequest":
                {
                    "name" : "{http:\/\/www.alfresco.org\/model\/solrfacetcustomproperty\/1.0}blockIncludeFacetRequest",
                    "value" : "true"
                }
             }
             "isEnabled" : true,
             "isDefault" : true
          }
      ]
   }
   Notes:
   - user must be an Admin, member of SkyVault_Search_Administrators group or a Network Admin for given network/tenant
   
      
The web script description document specifies the following options:
Value Description
json The default response format
user The authentication access
required The transaction level
argument The format style