Rebuild the Search Index and its related docs

post/search/indices/{indexId}
Internal-Use Only

Delete and rebuild the index from the content in the Catalog service. The index rebuild runs asynchronously via a Job Execution Service job, which can be polled for status.

Request Samples

1

Response Samples

1{
2  "createdBy": "sasuser",
3  "modifiedBy": "sasuser",
4  "version": 4,
5  "id": "80520af5-af95-4e50-b7e6-36dfb8622c06",
6  "state": "running",
7  "heartbeatInterval": 30,
8  "heartbeatTimeStamp": "2021-09-29T19:48:01.57Z",
9  "elapsedTime": 273,
10  "submittedByApplication": "jobExecution",
11  "links": [
12    {
13      "method": "GET",
14      "rel": "self",
15      "href": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06",
16      "uri": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06",
17      "type": "application/vnd.sas.job.execution.job"
18    },
19    {
20      "method": "GET",
21      "rel": "state",
22      "href": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06/state",
23      "uri": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06/state",
24      "type": "text/plain"
25    },
26    {
27      "method": "PUT",
28      "rel": "update",
29      "href": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06",
30      "uri": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06",
31      "type": "application/vnd.sas.job.execution.job",
32      "responseType": "application/vnd.sas.job.execution.job"
33    },
34    {
35      "method": "DELETE",
36      "rel": "delete",
37      "href": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06",
38      "uri": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06"
39    },
40    {
41      "method": "PUT",
42      "rel": "updateState",
43      "href": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06/state",
44      "uri": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06/state",
45      "type": "text/plain"
46    },
47    {
48      "method": "POST",
49      "rel": "updateHeartbeatTimeStamp",
50      "href": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06/heartbeatTimeStamp",
51      "uri": "/jobExecution/jobs/80520af5-af95-4e50-b7e6-36dfb8622c06/heartbeatTimeStamp",
52      "type": "text/plain"
53    }
54  ],
55  "jobRequest": {
56    "version": 3,
57    "name": "Index Maintenance (datasets)",
58    "description": "Maintain an Index",
59    "expiresAfter": "PT168H",
60    "createdByApplication": "jobExecution",
61    "jobDefinition": {
62      "version": 2,
63      "name": "indexMaintenance",
64      "type": "CATALOG",
65      "code": "{\"index\":\"datasets\"}"
66    }
67  },
68  "creationTimeStamp": "2021-09-29T19:48:01.3Z",
69  "modifiedTimeStamp": "2021-09-29T19:48:01.571Z"
70}

Path Parameters

NameTypeRequiredDescription
indexId
string
true

The ID of the Search Index definition

Query Parameters

NameTypeRequiredDescription
action
string
true

The action parameter for the rebuild request.

Allowed value:
rebuild
Default:
rebuild

Responses

StatusMeaningDescription
202AcceptedThe request was accepted.HeadersSchema
404Not FoundThe specified resource was not found.Schema
406Not AcceptableNot Acceptable. Include an Accept header with a supported value on the request.Schema
500Internal Server ErrorThe Catalog service encountered an error.Schema