Get Search Results

get/search

Search for instances by name, potentially specifying wildcards ('*' for 0 or more characters, '?' for a single character). Search can return data from multiple indices each of which can contain different types of objects.

Request Samples

Response Samples


1{
2  "version": 2,
3  "accept": "application/vnd.sas.metadata.search.result",
4  "count": 1,
5  "start": 0,
6  "limit": 10,
7  "name": "catalogSearchResults",
8  "items": [
9    {
10      "id": "0904b463-2366-2d4d-a43b-07578af2e9e8",
11      "version": 1,
12      "name": "BASEBALL",
13      "type": "sasTable",
14      "typeLabel": "SAS Table",
15      "owner": "sas",
16      "created": "2021-08-06T16:33:30.749Z",
17      "modified": "2021-08-06T16:33:30.749Z",
18      "score": 20.119299,
19      "attributes": {
20        "analysisTimeStamp": "2021-09-13T14:20:44.899Z",
21        "columnCount": 24,
22        "completenessPercent": 98.473084886,
23        "dataSize": 196608,
24        "extension": "sas7bdat",
25        "library": "SASHELP",
26        "region": "",
27        "reviewStatus": "none",
28        "rowCount": 322,
29        "sourceSystem": "SAS"
30      },
31      "links": [
32        {
33          "method": "GET",
34          "rel": "self",
35          "href": "/catalog/instances/0904b463-2366-2d4d-a43b-07578af2e9e8",
36          "uri": "/catalog/instances/0904b463-2366-2d4d-a43b-07578af2e9e8",
37          "type": "application/vnd.sas.metadata.instance.entity"
38        },
39        {
40          "method": "GET",
41          "rel": "resource",
42          "href": "/dataTables/dataSources/Compute~fs~c006f500-c10f-4db2-81c9-258f20b4d711~fs~SASHELP/tables/BASEBALL",
43          "uri": "/dataTables/dataSources/Compute~fs~c006f500-c10f-4db2-81c9-258f20b4d711~fs~SASHELP/tables/BASEBALL",
44          "type": "application/json"
45        }
46      ]
47    }
48  ],
49  "links": [
50    {
51      "method": "GET",
52      "rel": "collection",
53      "href": "/catalog/search",
54      "uri": "/catalog/search",
55      "type": "application/vnd.sas.collection",
56      "itemType": "application/vnd.sas.metadata.search.result"
57    },
58    {
59      "method": "GET",
60      "rel": "self",
61      "href": "/catalog/search?start=0&limit=10",
62      "uri": "/catalog/search?start=0&limit=10",
63      "type": "application/vnd.sas.collection",
64      "itemType": "application/vnd.sas.metadata.search.result"
65    },
66    {
67      "method": "GET",
68      "rel": "up",
69      "href": "/catalog",
70      "uri": "/catalog",
71      "type": "application/vnd.sas.api"
72    }
73  ],
74  "maxScore": 20.119299,
75  "query": "name: BASEBALL"
76}

Query Parameters


excludedIndices	array [string]	false	The index or indices to exclude from the search. If multiple indices are specified, the index names must be separated with commas. If an index is specified in both the indices and excludedIndices, it will be excluded.
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.
syntax	string	false	The type of the `q` query being executed. This parameter determines how the query will be processed. By default, with the `catalog` syntax, or if not set, a provided query is expected to conform to catalog faceted search syntax. When syntax is set to `text`, a best effort attempt is made to convert the provided query to the catalog faceted search syntax. Allowed values: catalogtext
timezone	string	false	The timezone of the query being searched. Timezones must be denoted by their TZ database names found in the IANA Timezone Database or their UTC offsets. Note: This query parameter is deprecated and timezone or time offset can be specified in the search query itself. If a timezone or time offset is included both via this parameter and in the search query then the value from the search query will be used. Default: Etc/UTC
q	string	true	A pattern to use when matching the name of an instance.

Header Parameters


Accept	string	false	The desired representation for the response. Allowed values: application/vnd.sas.metadata.search.collection+jsonapplication/vnd.sas.metadata.search.query+jsonapplication/json Default: application/vnd.sas.metadata.search.collection+json
Accept-Item	string	false	The desired item representation for collections. Allowed values: application/vnd.sas.metadata.search.result+jsonapplication/json Default: application/vnd.sas.metadata.search.result+json

Responses

Status	Meaning	Description
200	OK	OK.	Headers	Schema
400	Bad Request
401	Unauthorized	Not authenticated.		Schema
403	Forbidden
404	Not Found	The Catalog service is not available.		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