REST API for Oracle Commerce Cloud December 2017

getSearchSchedule

get

/ccadmin/v1/search/schedule

Get Search Schedule. Return a representation of the recurring baseline index schedule, if any. The returned properties correspond to values from the backing atg.service.scheduler.CalendarSchedule instance.

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 : getSearchSchedule_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":"1",
    "months":"*",
    "parseString":"* * * * * 35",
    "minutes":"35",
    "daysOfMonth":"*",
    "timeZone":"PST",
    "daysOfWeek":"*"
}

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:

{
  "occurrences": "*",
  "hours": "1",
  "months": "*",
  "parseString": "* * * * * 35",
  "minutes": "35",
  "daysOfMonth": "*",
  "timeZone": "PST",
  "daysOfWeek": "*"
}