Jump to

• Request
• Response

getSearchPartialSchedule

get

/ccadmin/v1/search/partialSchedule

Get Search Partial Schedule. Return a representation of the recurring partial index schedule, if any. The returned properties correspond to the calendar schedule values.

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

Type: object

Show Source

• daysOfMonth(optional): string
  The day or days of the month on which the schedule occurs.
• daysOfWeek(optional): string
  The day or days of the week on which the schedule occurs.
• hours(optional): string
  The hours of the day on which the schedule occurs.
• minutes(optional): string
  The minutes of the hour on which the schedule occurs.
• months(optional): string
  The month or months on which the schedule occurs. Not used if parseString is specified.
• occurrences(optional): string
  The occurence of the day or days of the week on which the schedule occurs.
• op(optional): string
  'partial' for a partial/incremental index, 'baseline' for a baseline index or 'baseline-full-export' for a baseline with full catalog export.
• parseString(optional): string
  The complete calendar schedule parse string.
• timeZone(optional): string
  The time zone of the schedule.

{
    "properties":{
        "occurrences":{
            "description":"The occurence of the day or days of the week on which the schedule occurs.",
            "type":"string"
        },
        "op":{
            "description":"'partial' for a partial/incremental index, 'baseline' for a baseline index or 'baseline-full-export' for a baseline with full catalog export.",
            "type":"string"
        },
        "hours":{
            "description":"The hours of the day on which the schedule occurs.",
            "type":"string"
        },
        "months":{
            "description":"The month or months on which the schedule occurs. Not used if parseString is specified.",
            "type":"string"
        },
        "parseString":{
            "description":"The complete calendar schedule parse string.",
            "type":"string"
        },
        "minutes":{
            "description":"The minutes of the hour on which the schedule occurs.",
            "type":"string"
        },
        "daysOfMonth":{
            "description":"The day or days of the month on which the schedule occurs.",
            "type":"string"
        },
        "timeZone":{
            "description":"The time zone of the schedule.",
            "type":"string"
        },
        "daysOfWeek":{
            "description":"The day or days of the week on which the schedule occurs.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "occurrences":"*",
    "hours":"*",
    "months":"*",
    "parseString":"* * * * * 0,15,30,45",
    "minutes":"0,15,30,45",
    "daysOfMonth":"*",
    "timeZone":"UTC",
    "daysOfWeek":"*"
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "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(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

{
    "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