REST API for Oracle Commerce Cloud December 2017

setSearchSchedule

put

/ccadmin/v1/search/schedule

Set Search Schedule. Schedule a recurring baseline index using an atg.service.scheduler.CalendarSchedule. 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

application/json

Body Parameter

Root Schema : setSearchSchedule_request

Example


{
    "occurrences":"*",
    "hours":"2",
    "months":"*",
    "minutes":"01",
    "daysOfMonth":"*",
    "timeZone":"EST",
    "daysOfWeek":"*"
}

Properties

daysOfMonth: Type: string

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 "*").
daysOfWeek: Type: string

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 "*").
hours: Type: string

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 "*").
locale: Type: string

The optional locale to use. Defaults to the US locale.
minutes: Type: string

Required: true

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 "*").
months: Type: string

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 "*").
occurrences: Type: string

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 "*").
parseString: Type: string

The complete atg.service.scheduler.CalendarSchedule parse string. If present, will be used instead of hours, minutes, etc. A null parseString value will delete the baseline schedule
timeZone: Type: string

The optional time zone to use when interpretting the schedule. If not specified, defaults to the time zone of the server JVM.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : setSearchSchedule_response

Properties

daysOfMonth: Type: string

The day or days of the month on which the schedule occurs.
daysOfWeek: Type: string

The day or days of the week on which the schedule occurs.
hours: Type: string

The hours of the day on which the schedule occurs.
minutes: Type: string

The minutes of the hour on which the schedule occurs.
months: Type: string

The month or months on which the schedule occurs. Not used if parseString is specified.
occurrences: Type: string

The occurence of the day or days of the week on which the schedule occurs.
parseString: Type: string

The complete atg.service.scheduler.CalendarSchedule parse string.
timeZone: Type: string

The time zone of the schedule.

Example application/json


{
    "occurrences":"*",
    "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|Search index Invalid Schedule| |31042|Search admin index internal error| |34081|Search schedule index internal error|

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 Request:

{
  "occurrences": "*",
  "hours": "2",
  "months": "*",
  "minutes": "01",
  "daysOfMonth": "*",
  "timeZone": "EST",
  "daysOfWeek": "*"
}

Sample Response Payload returned by endpoint:

{
  "occurrences": "*",
  "hours": "2",
  "months": "*",
  "parseString": "* * * * * 35",
  "minutes": "01",
  "daysOfMonth": "*",
  "timeZone": "EST",
  "daysOfWeek": "*"
}