Jump to

• Request
• Response

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

Body ()

Root Schema : requestIndex_request

Type: object

Show Source

• 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.

{
    "properties":{
        "op":{
            "description":"Set to 'partial' for a partial/incremental index, 'baseline' for a baseline index or 'baseline-full-export' for a baseline with full catalog export.",
            "type":"string"
        },
        "onlyIfIdle":{
            "description":"If true, will never queue a background index.",
            "type":"boolean"
        }
    },
    "required":[
        "op"
    ],
    "example":{
        "onlyIfIdle":true
    }
}

Example:

{
    "onlyIfIdle":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : requestIndex_response

Type: object

Show Source

• executionStarted(optional): boolean
  Whether an index was started immediately.
• queued(optional): boolean
  Whether an index was queued.

{
    "properties":{
        "queued":{
            "description":"Whether an index was queued.",
            "type":"boolean"
        },
        "executionStarted":{
            "description":"Whether an index was started immediately.",
            "type":"boolean"
        }
    }
}

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|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top