Get Search Facets

get/search/facets

Internal-Use Only

Get a collection of search facets.

Request Samples

Response Samples

200
application/vnd.sas.metadata.search.collection+json
1{
2  "version": 2,
3  "accept": "application/vnd.sas.metadata.definition.search.facet",
4  "count": 2,
5  "start": 0,
6  "limit": 10,
7  "name": "catalogSearchFacets",
8  "items": [
9    {
10      "version": 1,
11      "name": "AssetLabel",
12      "indices": [
13        "dataflows",
14        "datasets",
15        "dataplans",
16        "models",
17        "modelprojects",
18        "modelstudioprojects",
19        "reports",
20        "rulesets",
21        "referencedatadomains",
22        "codefiles",
23        "decisions",
24        "riskdataprojects",
25        "riskmodels"
26      ],
27      "type": "text"
28    },
29    {
30      "version": 1,
31      "name": "AssetName",
32      "indices": [
33        "dataflows",
34        "datasets",
35        "dataplans",
36        "models",
37        "modelprojects",
38        "modelstudioprojects",
39        "reports",
40        "rulesets",
41        "referencedatadomains",
42        "codefiles",
43        "decisions",
44        "riskdataprojects",
45        "riskmodels"
46      ],
47      "type": "text"
48    }
49  ],
50  "links": [
51    {
52      "method": "GET",
53      "rel": "collection",
54      "href": "/catalog/search/facets",
55      "uri": "/catalog/search/facets",
56      "type": "application/vnd.sas.collection",
57      "itemType": "application/vnd.sas.metadata.definition.search.facet"
58    },
59    {
60      "method": "GET",
61      "rel": "self",
62      "href": "/catalog/search/facets?start=0&limit=10",
63      "uri": "/catalog/search/facets?start=0&limit=10",
64      "type": "application/vnd.sas.collection",
65      "itemType": "application/vnd.sas.metadata.definition.search.facet"
66    },
67    {
68      "method": "GET",
69      "rel": "up",
70      "href": "/catalog/search",
71      "uri": "/catalog/search",
72      "type": "application/vnd.sas.metadata.search.collection"
73    }
74  ]
75}

Query Parameters

Name	Type	Required	Description
index(Deprecated)	array [string]	false	The index or indices to search. If multiple indices are specified, the index names must be separated with commas. This field is deprecated - please use indices instead. Default: catalog
indices	array [string]	false	The index or indices to search. If multiple indices are specified, the index names must be separated with commas. Default: catalog
q	string	true	A pattern that matches any part of a facet name; values are case-insensitive.
includeHidden	boolean	false	A boolean value that indicates that hidden facets should be returned in the results.
limit	integer	false	Maximum number of objects to return. Defaults to 10.
start	integer	false	0-based Offset of first object to return. Defaults to 0.

Header Parameters

Name	Type	Required	Description
Accept	string	false	The desired representation for the response. Allowed values: application/vnd.sas.collection+jsonapplication/json Default: application/vnd.sas.collection+json
Accept-Item	string	false	The desired item representation for collections. Allowed values: application/vnd.sas.metadata.definition.search.facet+jsonapplication/json Default: application/vnd.sas.metadata.definition.search.facet+json

Responses

Status	Meaning	Description
200	OK	OK.	Headers	Schema
400	Bad Request	Bad request (the request is not well-formed).		Schema
401	Unauthorized	Not authenticated.		Schema
403	Forbidden	The user does not have permission to complete this request.		Schema
404	Not Found	The specified resource was not found.		Schema
406	Not Acceptable	Not Acceptable. Include an Accept header with a supported value on the request.		Schema
502	Bad Gateway	Bad Gateway: The catalog service was unable to interact with the search engine. More details may be available in the error object.		Schema