getTextSearchSettings
get
/ccadmin/v1/merchant/textSearch
Get the Text search settings
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getTextSearchSettings_response
Type:
Show Source
object
-
enabled(optional):
boolean
Flag indicates whether text search is enabled or not.
-
errorMessage(optional):
string
error message if there is any error while performing text search setup.
-
scheduledJobs(optional):
array scheduledJobs
List of scheduled Jobs created. This feild is returned once setup is done and scheduled jobs are created
-
scheduledJobsInputData(optional):
array scheduledJobsInputData
List of scheduled Jobs Data given in the input. This field is returned only when setup is 'inProgress'
-
setupRunning(optional):
boolean
Flag indicates whether text search setup is running or not.
-
statusMessage(optional):
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
Show Source
Nested Schema : scheduledJobsInputData
Type:
array
List of scheduled Jobs Data given in the input. This field is returned only when setup is 'inProgress'
Show Source
Nested Schema : items
Type:
Show Source
object
-
componentPath(optional):
string
Supported scheduled job path
-
schedule(optional):
object schedule
-
scheduleDescription(optional):
string
Descriptive schedule information
-
scheduledJobName(optional):
string
Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'
-
scheduleType(optional):
string
Schedule type could be periodic or calendar
Nested Schema : schedule
Type:
Show Source
object
-
period(optional):
integer
It contains value in milliseconds.
Nested Schema : items
Type:
Show Source
object
-
schedule(optional):
object schedule
-
scheduleDescription(optional):
string
Descriptive schedule information
-
scheduledJobName(optional):
string
Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'
-
scheduleType(optional):
string
Schedule type could be periodic or calendar
Nested Schema : schedule
Type:
Show Source
object
-
period(optional):
integer
It contains value in milliseconds.
Example Response (application/json)
{
"setupRunning":false,
"errorMessage":"",
"enabled":false,
"statusMessage":""
}
Default Response
The error response
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