Jump to

• Request
• Response

getTextSearchSettings

get

/ccadmin/v1/merchant/textSearch

Get the Text search settings

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getTextSearchSettings_response

Type: object

Show Source

• enabled: boolean
  Flag indicates whether text search is enabled or not.
• errorMessage: string
  error message if there is any error while performing text search setup.
• scheduledJobs: array scheduledJobs
  List of scheduled Jobs created. This field is returned once setup is done and scheduled jobs are created
• scheduledJobsInputData: array scheduledJobsInputData
  List of scheduled Jobs Data given in the input. This field is returned only when setup is 'inProgress'
• setupRunning: boolean
  Flag indicates whether text search setup is running or not.
• statusMessage: string
  Status message if any text search setup is running, otherwise returns empty string.

{
    "properties":{
        "setupRunning":{
            "description":"Flag indicates whether text search setup is running or not.",
            "type":"boolean"
        },
        "scheduledJobsInputData":{
            "description":"List of scheduled Jobs Data given in the input. This field is returned only when setup is 'inProgress'",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "schedule":{
                        "type":"object",
                        "properties":{
                            "period":{
                                "description":"It contains value in milliseconds.",
                                "type":"integer"
                            }
                        }
                    },
                    "scheduledJobName":{
                        "description":"Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'",
                        "type":"string"
                    },
                    "scheduleDescription":{
                        "description":"Descriptive schedule information",
                        "type":"string"
                    },
                    "scheduleType":{
                        "description":"Schedule type could be periodic or calendar",
                        "type":"string"
                    }
                }
            }
        },
        "scheduledJobs":{
            "description":"List of scheduled Jobs created. This field is returned once setup is done and scheduled jobs are created",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "schedule":{
                        "type":"object",
                        "properties":{
                            "period":{
                                "description":"It contains value in milliseconds.",
                                "type":"integer"
                            }
                        }
                    },
                    "scheduledJobName":{
                        "description":"Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'",
                        "type":"string"
                    },
                    "scheduleDescription":{
                        "description":"Descriptive schedule information",
                        "type":"string"
                    },
                    "scheduleType":{
                        "description":"Schedule type could be periodic or calendar",
                        "type":"string"
                    },
                    "componentPath":{
                        "description":"Supported scheduled job path",
                        "type":"string"
                    }
                }
            }
        },
        "errorMessage":{
            "description":"error message if there is any error while performing text search setup.",
            "type":"string"
        },
        "enabled":{
            "description":"Flag indicates whether text search is enabled or not.",
            "type":"boolean"
        },
        "statusMessage":{
            "description":"Status message if any text search setup is running, otherwise returns empty string.",
            "type":"string"
        }
    }
}

Nested Schema : scheduledJobs

Type: array

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

Show Source

• Array of: object items

{
    "description":"List of scheduled Jobs created. This field is returned once setup is done and scheduled jobs are created",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "schedule":{
                "type":"object",
                "properties":{
                    "period":{
                        "description":"It contains value in milliseconds.",
                        "type":"integer"
                    }
                }
            },
            "scheduledJobName":{
                "description":"Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'",
                "type":"string"
            },
            "scheduleDescription":{
                "description":"Descriptive schedule information",
                "type":"string"
            },
            "scheduleType":{
                "description":"Schedule type could be periodic or calendar",
                "type":"string"
            },
            "componentPath":{
                "description":"Supported scheduled job path",
                "type":"string"
            }
        }
    }
}

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

• Array of: object items

{
    "description":"List of scheduled Jobs Data given in the input. This field is returned only when setup is 'inProgress'",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "schedule":{
                "type":"object",
                "properties":{
                    "period":{
                        "description":"It contains value in milliseconds.",
                        "type":"integer"
                    }
                }
            },
            "scheduledJobName":{
                "description":"Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'",
                "type":"string"
            },
            "scheduleDescription":{
                "description":"Descriptive schedule information",
                "type":"string"
            },
            "scheduleType":{
                "description":"Schedule type could be periodic or calendar",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• componentPath: string
  Supported scheduled job path
• schedule: object schedule
• scheduleDescription: string
  Descriptive schedule information
• scheduledJobName: string
  Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'
• scheduleType: string
  Schedule type could be periodic or calendar

{
    "type":"object",
    "properties":{
        "schedule":{
            "type":"object",
            "properties":{
                "period":{
                    "description":"It contains value in milliseconds.",
                    "type":"integer"
                }
            }
        },
        "scheduledJobName":{
            "description":"Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'",
            "type":"string"
        },
        "scheduleDescription":{
            "description":"Descriptive schedule information",
            "type":"string"
        },
        "scheduleType":{
            "description":"Schedule type could be periodic or calendar",
            "type":"string"
        },
        "componentPath":{
            "description":"Supported scheduled job path",
            "type":"string"
        }
    }
}

Nested Schema : schedule

Type: object

Show Source

• period: integer
  It contains value in milliseconds.

{
    "type":"object",
    "properties":{
        "period":{
            "description":"It contains value in milliseconds.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• schedule: object schedule
• scheduleDescription: string
  Descriptive schedule information
• scheduledJobName: string
  Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'
• scheduleType: string
  Schedule type could be periodic or calendar

{
    "type":"object",
    "properties":{
        "schedule":{
            "type":"object",
            "properties":{
                "period":{
                    "description":"It contains value in milliseconds.",
                    "type":"integer"
                }
            }
        },
        "scheduledJobName":{
            "description":"Name of the scheduled Job. Valid scheduled Jobs are: 'orderIncrementalIndexingSchedule', 'profileIncrementalIndexingSchedule','orderOptimizationSchedule','profileOptimizationSchedule'",
            "type":"string"
        },
        "scheduleDescription":{
            "description":"Descriptive schedule information",
            "type":"string"
        },
        "scheduleType":{
            "description":"Schedule type could be periodic or calendar",
            "type":"string"
        }
    }
}

Nested Schema : schedule

Type: object

Show Source

• period: integer
  It contains value in milliseconds.

{
    "type":"object",
    "properties":{
        "period":{
            "description":"It contains value in milliseconds.",
            "type":"integer"
        }
    }
}

Example Response (application/json)

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

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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