1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Admin
  4. Search Data and Indexing
  5. Indexing

setSearchSchedule

put

/ccadmin/v1/search/schedule

Set Search Schedule. Schedule a recurring baseline, partial or baseline full export index using a calendar schedule. This method allows setting the schedule from a parseString, and from component parts (hours, minutes, etc). The parseString property will override component part properties, if present.

Request

Supported Media Types
Body ()
Root Schema : setSearchSchedule_request
Type: object
Show Source
  • The day or days of the month on which the schedule occurs. Not used if parseString is specified. If neither parseString or daysOfMonth is specified, defaults to all days of the month (equivalent to "*").
  • The day or days of the week on which the schedule occurs. Not used if parseString is specified. If neither parseString nor daysOfWeek is specified, defaults to all days of the the week (equivalent to "*").
  • The hours of the day on which the schedule occurs. Not used if parseString is specified. If neither parseString nor hours is specified, defaults to all hours of the day (equivalent to "*").
  • The optional locale to use. Defaults to the US locale.
  • The minutes of the hour on which the schedule occurs. Not used if parseString is specified. If neither parseString nor minutes is specified, defaults to all minutes of the hour (equivalent to "*").
  • The month or months on which the schedule occurs. Not used if parseString is specified. If neither parseString or months is specified, defaults to all months (equivalent to "*").
  • The occurence of the day or days of the week on which the schedule occurs. Not used if parseString is specified. If neither parseString or occurences is specified, defaults to all occurences in the month (equivalent to "*").
  • Set to 'partial' for a partial/incremental index, 'baseline' for a baseline index or 'baseline-full-export' for a baseline with full catalog export.
  • The complete calendar schedule parse string. If present, will be used instead of hours, minutes, etc. A null parseString value will delete the baseline schedule
  • The optional time zone to use when interpretting the schedule. If not specified, defaults to the time zone of the server JVM.
Example:
{
    "occurrences":"*",
    "op":"baseline-full-export",
    "hours":"2",
    "months":"*",
    "minutes":"01",
    "daysOfMonth":"*",
    "timeZone":"EST",
    "daysOfWeek":"*"
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : setSearchSchedule_response
Type: object
Show Source
Example Response (application/json)
{
    "occurrences":"*",
    "op":"baseline-full-export",
    "hours":"2",
    "months":"*",
    "parseString":"* * * * * 35",
    "minutes":"01",
    "daysOfMonth":"*",
    "timeZone":"EST",
    "daysOfWeek":"*"
}

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| |------------------|------------------| |34080|Invalid Schedule format| |34080|Either parseString parameter or one of the following parameters must be provided to set schedule: months, daysOfMonth, occurrences, daysOfWeek, hours, minutes.| |34080|An indexing schedule that occurs every minute is not allowed. Please specify a minute, list of minutes, or range of minutes.| |34080|String cannot be parsed as a number. {0}| |34080|Invalid value {0}: must be between {1} and {2} (inclusive)| |34080|Invalid date of month value {0}: must less than or equal to {1} in order to ever occur in any of the months specified: {2}| |31041|An internal search administration error occurred.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top