Create indices for all types

post/admin/indices

Internal-Use Only

Ensures that an index exists for each configured type when the searchable query parameter is set to true, otherwise creates new unsearchable indices for each configured type. This is especially required when re-indexing data from a source database (see example Use Case Five). No errors will be reported if the indices already exist. Returns the name of the newest index for each type.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "description": "An example of a response from admin/indices returning a list of the newest indices for each type.",
3  "value": {
4    "links": [
5      {
6        "method": "POST",
7        "rel": "self",
8        "href": "/svi-sand/admin/indices?start=0&limit=20",
9        "uri": "/svi-sand/admin/indices?start=0&limit=20",
10        "responseType": "application/vnd.sas.collection",
11        "responseItemType": "application/vnd.sas.sand.index"
12      },
13      {
14        "method": "POST",
15        "rel": "collection",
16        "href": "/svi-sand/admin/indices",
17        "uri": "/svi-sand/admin/indices",
18        "responseType": "application/vnd.sas.collection",
19        "responseItemType": "application/vnd.sas.sand.index"
20      },
21      {
22        "method": "POST",
23        "rel": "next",
24        "href": "/svi-sand/admin/indices?start=20&limit=20",
25        "uri": "/svi-sand/admin/indices?start=20&limit=20",
26        "responseType": "application/vnd.sas.collection",
27        "responseItemType": "application/vnd.sas.sand.index"
28      },
29      {
30        "method": "POST",
31        "rel": "last",
32        "href": "/svi-sand/admin/indices?start=20&limit=20",
33        "uri": "/svi-sand/admin/indices?start=20&limit=20",
34        "responseType": "application/vnd.sas.collection",
35        "responseItemType": "application/vnd.sas.sand.index"
36      }
37    ],
38    "name": "indices",
39    "accept": "application/vnd.sas.sand.index",
40    "start": 0,
41    "count": 2,
42    "items": [
43      {
44        "type": "document_link",
45        "name": "sand__document_link__1656665344057",
46        "links": [
47          {
48            "method": "GET",
49            "rel": "self",
50            "href": "/svi-sand/admin/indices/document_link",
51            "uri": "/svi-sand/admin/indices/document_link",
52            "responseType": "application/vnd.sas.sand.index"
53          },
54          {
55            "method": "POST",
56            "rel": "create",
57            "href": "/svi-sand/admin/indices/document_link",
58            "uri": "/svi-sand/admin/indices/document_link",
59            "responseType": "application/vnd.sas.sand.index"
60          },
61          {
62            "method": "POST",
63            "rel": "makeSearchable",
64            "href": "/svi-sand/admin/operations",
65            "uri": "/svi-sand/admin/operations",
66            "type": "application/vnd.sas.sand.operation.request",
67            "responseType": "application/vnd.sas.sand.operation.response"
68          },
69          {
70            "method": "DELETE",
71            "rel": "delete",
72            "href": "/svi-sand/admin/indices/document_link",
73            "uri": "/svi-sand/admin/indices/document_link"
74          }
75        ]
76      },
77      {
78        "type": "shape",
79        "name": "sand__shape__1656608940265",
80        "links": [
81          {
82            "method": "GET",
83            "rel": "self",
84            "href": "/svi-sand/admin/indices/shape",
85            "uri": "/svi-sand/admin/indices/shape",
86            "responseType": "application/vnd.sas.sand.index"
87          },
88          {
89            "method": "POST",
90            "rel": "create",
91            "href": "/svi-sand/admin/indices/shape",
92            "uri": "/svi-sand/admin/indices/shape",
93            "responseType": "application/vnd.sas.sand.index"
94          },
95          {
96            "method": "POST",
97            "rel": "makeSearchable",
98            "href": "/svi-sand/admin/operations",
99            "uri": "/svi-sand/admin/operations",
100            "type": "application/vnd.sas.sand.operation.request",
101            "responseType": "application/vnd.sas.sand.operation.response"
102          },
103          {
104            "method": "DELETE",
105            "rel": "delete",
106            "href": "/svi-sand/admin/indices/shape",
107            "uri": "/svi-sand/admin/indices/shape"
108          }
109        ]
110      }
111    ],
112    "limit": 20,
113    "version": 2
114  }
115}

Query Parameters

Name	Type	Required	Description
limit	integer	false	The maximum number of index names to include in each page. Default: 20
searchable	boolean	false	Whether to create searchable as opposed to unsearchable indices. Default: true
start	integer	false	The index of the first index name to include in the current page. Default: 0

Responses

Status	Meaning	Description
200	OK	The request succeeded.		Schema