REST API for Oracle Commerce Cloud December 2017

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.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : requestIndex_request

Example


{
    "onlyIfIdle":true
}

Properties

onlyIfIdle: Type: boolean

If true, will never queue a background index.
op: Type: string

Required: true

Set to 'partial' for a partial/incremental index, 'baseline' for a baseline index or 'baseline-full-export' for a baseline with full catalog export.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : requestIndex_response

Properties

executionStarted: Type: boolean

Whether an index was started immediately.
queued: Type: boolean

Whether an index was queued.

Example 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|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{"onlyIfIdle": true}

Sample Response Payload returned by endpoint:

{
  "queued": false,
  "executionStarted": true
}