requestIndex
post
/ccadmin/v1/search/index
Request Index. Request a partial, baseline or baseline-full-export index. May be started immediately (if no index is in progress), or queued.
**baseline-full-export**
This job will export the whole catalog / price data from Repositories and run the full indexing to index all the data in Record Stores.
**baseline** (also known as baseline partial export)
This job will only export the changed catalog / price data from Repositories and run the full indexing to index all the data (not just changed items) in Record Stores.
**partial**
This job will only export the changed catalog / price data from Repositories and run the partial indexing to index only changed data in Record Stores.
Request
Supported Media Types
- application/json
Root Schema : requestIndex_request
Type:
Show Source
object
-
onlyIfIdle(optional):
boolean
If true, will never queue a background index.
-
op:
string
Set to 'partial' for a partial/incremental index, 'baseline' for a baseline index or 'baseline-full-export' for a baseline with full catalog export.
Example:
{
"onlyIfIdle":true
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : requestIndex_response
Type:
Show Source
object
-
executionStarted(optional):
boolean
Whether an index was started immediately.
-
queued(optional):
boolean
Whether an index was queued.
Example Response (application/json)
{
"queued":false,
"executionStarted":true
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|34082|Execute Index Internal error|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code