Get Search Facets

get/search/facets

Get a collection of search facets.

Request Samples

Response Samples

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      "descriptions": {
48        "datasets": "The name of the dataset."
49      },
50      "type": "text"
51    }
52  ],
53  "links": [
54    {
55      "method": "GET",
56      "rel": "collection",
57      "href": "/catalog/search/facets",
58      "uri": "/catalog/search/facets",
59      "type": "application/vnd.sas.collection",
60      "itemType": "application/vnd.sas.metadata.definition.search.facet"
61    },
62    {
63      "method": "GET",
64      "rel": "self",
65      "href": "/catalog/search/facets?start=0&limit=10",
66      "uri": "/catalog/search/facets?start=0&limit=10",
67      "type": "application/vnd.sas.collection",
68      "itemType": "application/vnd.sas.metadata.definition.search.facet"
69    },
70    {
71      "method": "GET",
72      "rel": "up",
73      "href": "/catalog/search",
74      "uri": "/catalog/search",
75      "type": "application/vnd.sas.metadata.search.collection"
76    }
77  ]
78}

Query Parameters

includeHidden
boolean
false

A boolean value that indicates that hidden facets should be returned in the results.

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
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.

q
string
true

A pattern that matches any part of a facet name; values are case-insensitive.

Header Parameters

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

StatusMeaningDescription
200OK

OK.

HeadersSchema
400Bad Request
401Unauthorized

Not authenticated.

Schema
403Forbidden
404Not Found
406Not Acceptable

Not Acceptable. Include an Accept header with a supported value on the request.

Schema
502Bad Gateway

Bad Gateway: The catalog service was unable to interact with the search engine. More details may be available in the error object.

Schema