REST API for Oracle Commerce Cloud December 2017

getTextSearchSettings

get

/ccadmin/v1/merchant/textSearch

Get the Text search settings

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getTextSearchSettings_response

Properties

enabled: Type: boolean

Flag indicates whether text search is enabled or not.
errorMessage: Type: string

error message if there is any error while performing text search setup.
scheduledJobs: Type: array scheduledJobs

Additional Properties Allowed:

List of scheduled Jobs created. This feild is returned once setup is done and scheduled jobs are created
scheduledJobsInputData: Type: array scheduledJobsInputData

Additional Properties Allowed:

List of scheduled Jobs Data given in the input. This feild is returned only when setup is 'inProgress'
setupRunning: Type: boolean

Flag indicates whether text search setup is running or not.
statusMessage: Type: string

Status message if any text search setup is running, otherwise returns empty string.

Nested Schema : scheduledJobs

Type: array

List of scheduled Jobs created. This feild is returned once setup is done and scheduled jobs are created

Items

Type: object items

Additional Properties Allowed:

Nested Schema : scheduledJobsInputData

Type: array

List of scheduled Jobs Data given in the input. This feild is returned only when setup is 'inProgress'

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

componentPath: Type: string

Supported scheduled job path
schedule: Type: object schedule

Additional Properties Allowed:
scheduleDescription: Type: string

Descriptive schedule information
scheduledJobName: Type: string

Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'
scheduleType: Type: string

Schedule type could be periodic or calendar

Nested Schema : schedule

Type: object

Properties

period: Type: integer

It contains value in milliseconds.

Nested Schema : items

Type: object

Properties

schedule: Type: object schedule

Additional Properties Allowed:
scheduleDescription: Type: string

Descriptive schedule information
scheduledJobName: Type: string

Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'
scheduleType: Type: string

Schedule type could be periodic or calendar

Nested Schema : schedule

Type: object

Properties

period: Type: integer

It contains value in milliseconds.

Example application/json


{
    "setupRunning":false,
    "errorMessage":"",
    "enabled":false,
    "statusMessage":""
}

Default Response

The error response

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 Response Payload returned by endpoint:

{
  "setupRunning": false,
  "errorMessage": "",
  "enabled": false,
  "statusMessage": ""
}