Get Search Indices

get/search/indices
Internal-Use Only
Returns a list of search index definitions. The properties that can be used as filter and sort criteria are:
id,
name,
label,
createdBy,
creationTimeStamp,
modifiedBy, and
modifiedTimeStamp
Request Samples

Response Samples

200
application/vnd.sas.metadata.search.collection+json
1{
2  "version": 2,
3  "accept": "application/vnd.sas.metadata.definition.search.index",
4  "count": 1,
5  "start": 0,
6  "limit": 10,
7  "name": "indices",
8  "items": [
9    {
10      "creationTimeStamp": "2022-11-22T00:00:00Z",
11      "modifiedTimeStamp": "2022-11-22T00:00:00Z",
12      "id": "f2351f74-09cb-4fc2-96df-6131946c354b",
13      "links": [
14        {
15          "method": "GET",
16          "rel": "self",
17          "href": "/catalog/search/indices/f2351f74-09cb-4fc2-96df-6131946c354b",
18          "uri": "/catalog/search/indices/f2351f74-09cb-4fc2-96df-6131946c354b",
19          "type": "application/vnd.sas.metadata.definition.search.index"
20        },
21        {
22          "method": "GET",
23          "rel": "up",
24          "href": "/catalog/search/indices",
25          "uri": "/catalog/search/indices",
26          "type": "application/vnd.sas.collection",
27          "itemType": "application/vnd.sas.metadata.definition.search.index"
28        },
29        {
30          "method": "PUT",
31          "rel": "update",
32          "href": "/catalog/search/indices/f2351f74-09cb-4fc2-96df-6131946c354b",
33          "uri": "/catalog/search/indices/f2351f74-09cb-4fc2-96df-6131946c354b",
34          "type": "application/vnd.sas.metadata.definition.search.index",
35          "responseType": "application/vnd.sas.metadata.definition.search.index"
36        },
37        {
38          "method": "DELETE",
39          "rel": "delete",
40          "href": "/catalog/search/indices/f2351f74-09cb-4fc2-96df-6131946c354b",
41          "uri": "/catalog/search/indices/f2351f74-09cb-4fc2-96df-6131946c354b"
42        },
43        {
44          "method": "POST",
45          "rel": "rebuild",
46          "href": "/catalog/search/indices/datasets",
47          "uri": "/catalog/search/indices/datasets",
48          "itemType": "application/vnd.sas.job.execution.job"
49        }
50      ],
51      "name": "datasets",
52      "typeDefinition": "dataSet",
53      "properties": {
54        "accessor": {
55          "representation": [
56            "keyword",
57            "ngram",
58            "text"
59          ],
60          "stageName": "AccessedBy"
61        },
62        "analysisTimeStamp": {
63          "representation": [
64            "date"
65          ],
66          "stageName": "DateAnalyzed"
67        },
68        "columnCount": {
69          "representation": [
70            "integer"
71          ],
72          "stageName": "ColumnCount"
73        },
74        "completenessPercent": {
75          "representation": [
76            "float"
77          ],
78          "stageName": "Completeness"
79        },
80        "creator": {
81          "representation": [
82            "keyword",
83            "ngram",
84            "text"
85          ],
86          "stageName": "CreatedBy",
87          "source": "createdBy"
88        },
89        "dataLocale": {
90          "representation": [
91            "keyword"
92          ],
93          "freeText": true,
94          "stageName": "Locale"
95        },
96        "dataSize": {
97          "representation": [
98            "long"
99          ],
100          "stageName": "DatasetSize"
101        },
102        "dateAccessed": {
103          "representation": [
104            "date"
105          ],
106          "stageName": "DateAccessed"
107        },
108        "dateCreated": {
109          "representation": [
110            "date"
111          ],
112          "stageName": "DateCreated",
113          "source": "creationTimeStamp"
114        },
115        "dateModified": {
116          "representation": [
117            "date"
118          ],
119          "stageName": "DateModified",
120          "source": "modifiedTimeStamp"
121        },
122        "definitionId": {
123          "representation": [
124            "keyword"
125          ],
126          "stageName": "DefinitionID",
127          "facetDisplay": "hidden"
128        },
129        "description": {
130          "representation": [
131            "keyword",
132            "text"
133          ],
134          "freeText": true,
135          "stageName": "Description"
136        },
137        "editor": {
138          "representation": [
139            "keyword",
140            "ngram",
141            "text"
142          ],
143          "stageName": "ModifiedBy",
144          "source": "modifiedBy"
145        },
146        "extension": {
147          "representation": [
148            "keyword"
149          ],
150          "stageName": "FileExtension"
151        },
152        "informationPrivacy": {
153          "representation": [
154            "keyword"
155          ],
156          "freeText": true,
157          "stageName": "InformationPrivacy"
158        },
159        "keywords": {
160          "representation": [
161            "keyword",
162            "ngram",
163            "text"
164          ],
165          "freeText": true,
166          "stageName": "Keywords",
167          "suggestionsRepresentation": "csv"
168        },
169        "label": {
170          "representation": [
171            "keyword",
172            "ngram",
173            "text"
174          ],
175          "freeText": true,
176          "stageName": "Label"
177        },
178        "languagesIdentified": {
179          "representation": [
180            "keyword",
181            "ngram",
182            "text"
183          ],
184          "freeText": true,
185          "stageName": "Languages",
186          "suggestionsRepresentation": "csv"
187        },
188        "name": {
189          "representation": [
190            "keyword",
191            "ngram",
192            "text"
193          ],
194          "freeText": true,
195          "stageName": "Name"
196        },
197        "resourceId": {
198          "representation": [
199            "keyword",
200            "ngram",
201            "text"
202          ],
203          "stageName": "URI",
204          "facetDisplay": "hidden"
205        },
206        "reviewStatus": {
207          "representation": [
208            "keyword"
209          ],
210          "freeText": true,
211          "stageName": "Status"
212        },
213        "rowCount": {
214          "representation": [
215            "integer"
216          ],
217          "stageName": "RowCount"
218        },
219        "runId": {
220          "representation": [
221            "keyword"
222          ],
223          "facetDisplay": "hidden"
224        },
225        "runStatus": {
226          "representation": [
227            "keyword"
228          ],
229          "facetDisplay": "hidden"
230        },
231        "sourceSystem": {
232          "representation": [
233            "keyword"
234          ],
235          "freeText": true,
236          "facetDisplay": "hidden"
237        },
238        "topic": {
239          "representation": [
240            "keyword"
241          ],
242          "freeText": true,
243          "stageName": "Topic"
244        },
245        "topicKeywords": {
246          "representation": [
247            "keyword",
248            "ngram",
249            "text"
250          ],
251          "freeText": true,
252          "stageName": "TopicKeywords",
253          "suggestionsRepresentation": "csv"
254        },
255        "topicParent": {
256          "representation": [
257            "keyword"
258          ],
259          "freeText": true,
260          "stageName": "TopicParent"
261        },
262        "type": {
263          "representation": [
264            "keyword"
265          ],
266          "stageName": "Type",
267          "facetDisplay": "hidden"
268        }
269      },
270      "children": {
271        "assetContacts": {
272          "name": "assetContacts",
273          "peer": {
274            "name": "principal",
275            "typeDefinition": "principal",
276            "properties": {
277              "name": {
278                "representation": [
279                  "keyword",
280                  "ngram",
281                  "text"
282                ],
283                "stageName": "Contacts"
284              }
285            },
286            "facetDisplay": "hidden"
287          },
288          "facetDisplay": "hidden"
289        },
290        "dataSetDataFields": {
291          "name": "dataSetDataFields",
292          "peer": {
293            "name": "dataField",
294            "typeDefinition": "dataField",
295            "properties": {
296              "dataType": {
297                "representation": [
298                  "keyword"
299                ]
300              },
301              "description": {
302                "representation": [
303                  "text"
304                ],
305                "freeText": true
306              },
307              "informationPrivacy": {
308                "representation": [
309                  "keyword"
310                ],
311                "stageName": "informationPrivacy"
312              },
313              "keywords": {
314                "representation": [
315                  "keyword",
316                  "ngram",
317                  "text"
318                ],
319                "freeText": true,
320                "stageName": "keywords",
321                "suggestionsRepresentation": "csv"
322              },
323              "label": {
324                "representation": [
325                  "keyword",
326                  "ngram",
327                  "text"
328                ],
329                "freeText": true
330              },
331              "name": {
332                "representation": [
333                  "keyword",
334                  "ngram",
335                  "text"
336                ],
337                "freeText": true
338              },
339              "reviewStatus": {
340                "representation": [
341                  "keyword"
342                ],
343                "stageName": "status"
344              },
345              "semanticTypeId": {
346                "representation": [
347                  "keyword"
348                ],
349                "stageName": "semanticType"
350              }
351            },
352            "stageName": "Column"
353          },
354          "facetDisplay": "hidden"
355        },
356        "dataStoreDataSets": {
357          "name": "dataStoreDataSets",
358          "inverse": true,
359          "peer": {
360            "name": "dataStore",
361            "typeDefinition": "dataStore",
362            "properties": {
363              "name": {
364                "representation": [
365                  "keyword",
366                  "ngram",
367                  "text"
368                ],
369                "freeText": true
370              },
371              "region": {
372                "representation": [
373                  "keyword",
374                  "ngram",
375                  "text"
376                ],
377                "freeText": true
378              }
379            },
380            "stageName": "Library"
381          },
382          "facetDisplay": "hidden"
383        }
384      },
385      "tags": {
386        "stageName": "Tags",
387        "name": "tags"
388      },
389      "annotation": {
390        "relationshipType": "dataSetDataSetAnnotations",
391        "properties": [
392          "reviewStatus",
393          "description",
394          "accessor",
395          "dateAccessed"
396        ]
397      },
398      "label": "Data sets",
399      "description": "The metadata of a data set, table, or file.",
400      "aliases": {
401        "catalog": {}
402      },
403      "i18nSource": "catalog-gui-icu",
404      "iconSource": "sas.icons.OBJECTTYPES.DATATABLE_OBJ",
405      "version": 1
406    }
407  ],
408  "links": [
409    {
410      "method": "GET",
411      "rel": "self",
412      "href": "/catalog/search/indices?start=0&limit=10&filter=eq%28name%2C%27datasets%27%29&sortBy=label:descending",
413      "uri": "/catalog/search/indices?start=0&limit=10&filter=eq%28name%2C%27datasets%27%29&sortBy=label:descending",
414      "type": "application/vnd.sas.collection",
415      "itemType": "application/vnd.sas.metadata.definition.search.index"
416    },
417    {
418      "method": "GET",
419      "rel": "collection",
420      "href": "/catalog/search/indices",
421      "uri": "/catalog/search/indices",
422      "type": "application/vnd.sas.collection",
423      "itemType": "application/vnd.sas.metadata.definition.search.index"
424    },
425    {
426      "method": "GET",
427      "rel": "up",
428      "href": "/catalog/search",
429      "uri": "/catalog/search",
430      "type": "application/vnd.sas.api"
431    },
432    {
433      "method": "POST",
434      "rel": "create",
435      "href": "/catalog/search/indices",
436      "uri": "/catalog/search/indices",
437      "type": "application/vnd.sas.metadata.definition.search.index",
438      "responseType": "application/vnd.sas.metadata.definition.search.index"
439    }
440  ]
441}
Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	Filter criteria for returned objects. See Filtering in REST APIs.
limit	integer	false	Maximum number of objects to return. Defaults to 10.
sortBy	string<sort-criteria>	false	Sort returned objects. See Sorting in REST APIs.
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.index+jsontext/plainapplication/json Default: application/vnd.sas.metadata.definition.search.index+json
Responses

Status	Meaning	Description
200	OK	OK.	Headers	Schema
401	Unauthorized	Not authenticated.		Schema
403	Forbidden	The user does not have permission to complete this request.		Schema
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