REST API for Oracle Commerce Cloud 21B

getPublishSchedule

get

/ccadmin/v1/publish/schedules

Get Publish Schedule. Get a list of scheduled publishes.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getPublishSchedule_response

Type: object

Show Source

items(optional): array items

Items of scheduled publishing.
limit(optional): integer

Limit of number of scheduled publishes.
offset(optional): integer

offset.
sort(optional): array sort

Sort information of the scheduled publishing.
total(optional): integer

Total number of scheduled publishes.

{
    "properties":{
        "total":{
            "description":"Total number of scheduled publishes.",
            "type":"integer"
        },
        "offset":{
            "description":"offset.",
            "type":"integer"
        },
        "limit":{
            "description":"Limit of number of scheduled publishes.",
            "type":"integer"
        },
        "sort":{
            "description":"Sort information of the scheduled publishing.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"Property of publish.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order of publish.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"Items of scheduled publishing.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dateTime":{
                        "description":"Date and time of scheduled publish.",
                        "type":"string"
                    },
                    "firstName":{
                        "description":"First name of the Profile of scheduled publish.",
                        "type":"string"
                    },
                    "lastName":{
                        "description":"Last name of the Profile of scheduled publish.",
                        "type":"string"
                    },
                    "repeatFrequency":{
                        "description":"Optionally enables this publishing event to occur repeatedly.  Use one of these frequency codes: 100 (hourly), 101 (daily), 102 (weekly), 103 (monthtly) or 104 (yearly).",
                        "type":"integer"
                    },
                    "repeatEndTime":{
                        "description":"An optional timestamp (ISO 8601) to end the repeated publishing event.  Use in conjuction with repeatFrequency.  Repeat will occur forever if no end time is provided.",
                        "type":"string"
                    },
                    "profileId":{
                        "description":"Profile Id of scheduled publish.",
                        "type":"string"
                    },
                    "eventName":{
                        "description":"Name of the publish event.",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id of scheduled publish.",
                        "type":"integer"
                    },
                    "eventType":{
                        "description":"Type of publish event, 0 = full publsh, 1 = partial publish",
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Items of scheduled publishing.

Show Source

Array of: object items

{
    "description":"Items of scheduled publishing.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dateTime":{
                "description":"Date and time of scheduled publish.",
                "type":"string"
            },
            "firstName":{
                "description":"First name of the Profile of scheduled publish.",
                "type":"string"
            },
            "lastName":{
                "description":"Last name of the Profile of scheduled publish.",
                "type":"string"
            },
            "repeatFrequency":{
                "description":"Optionally enables this publishing event to occur repeatedly.  Use one of these frequency codes: 100 (hourly), 101 (daily), 102 (weekly), 103 (monthtly) or 104 (yearly).",
                "type":"integer"
            },
            "repeatEndTime":{
                "description":"An optional timestamp (ISO 8601) to end the repeated publishing event.  Use in conjuction with repeatFrequency.  Repeat will occur forever if no end time is provided.",
                "type":"string"
            },
            "profileId":{
                "description":"Profile Id of scheduled publish.",
                "type":"string"
            },
            "eventName":{
                "description":"Name of the publish event.",
                "type":"string"
            },
            "id":{
                "description":"Id of scheduled publish.",
                "type":"integer"
            },
            "eventType":{
                "description":"Type of publish event, 0 = full publsh, 1 = partial publish",
                "type":"integer"
            }
        }
    }
}

Nested Schema : sort

Type: array

Sort information of the scheduled publishing.

Show Source

Array of: object items

{
    "description":"Sort information of the scheduled publishing.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"Property of publish.",
                "type":"string"
            },
            "order":{
                "description":"Order of publish.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

dateTime(optional): string

Date and time of scheduled publish.
eventName(optional): string

Name of the publish event.
eventType(optional): integer

Type of publish event, 0 = full publsh, 1 = partial publish
firstName(optional): string

First name of the Profile of scheduled publish.
id(optional): integer

Id of scheduled publish.
lastName(optional): string

Last name of the Profile of scheduled publish.
profileId(optional): string

Profile Id of scheduled publish.
repeatEndTime(optional): string

An optional timestamp (ISO 8601) to end the repeated publishing event. Use in conjuction with repeatFrequency. Repeat will occur forever if no end time is provided.
repeatFrequency(optional): integer

Optionally enables this publishing event to occur repeatedly. Use one of these frequency codes: 100 (hourly), 101 (daily), 102 (weekly), 103 (monthtly) or 104 (yearly).

{
    "type":"object",
    "properties":{
        "dateTime":{
            "description":"Date and time of scheduled publish.",
            "type":"string"
        },
        "firstName":{
            "description":"First name of the Profile of scheduled publish.",
            "type":"string"
        },
        "lastName":{
            "description":"Last name of the Profile of scheduled publish.",
            "type":"string"
        },
        "repeatFrequency":{
            "description":"Optionally enables this publishing event to occur repeatedly.  Use one of these frequency codes: 100 (hourly), 101 (daily), 102 (weekly), 103 (monthtly) or 104 (yearly).",
            "type":"integer"
        },
        "repeatEndTime":{
            "description":"An optional timestamp (ISO 8601) to end the repeated publishing event.  Use in conjuction with repeatFrequency.  Repeat will occur forever if no end time is provided.",
            "type":"string"
        },
        "profileId":{
            "description":"Profile Id of scheduled publish.",
            "type":"string"
        },
        "eventName":{
            "description":"Name of the publish event.",
            "type":"string"
        },
        "id":{
            "description":"Id of scheduled publish.",
            "type":"integer"
        },
        "eventType":{
            "description":"Type of publish event, 0 = full publsh, 1 = partial publish",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

order(optional): string

Order of publish.
property(optional): string

Property of publish.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"Property of publish.",
            "type":"string"
        },
        "order":{
            "description":"Order of publish.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":1,
    "offset":0,
    "limit":1,
    "sort":[
        {
            "property":"dateTime",
            "order":"asc"
        }
    ],
    "items":[
        {
            "dateTime":"2014-03-18T14:18:00.000Z",
            "firstName":"Admin",
            "lastName":"User",
            "repeatFrequency":102,
            "repeatEndTime":"2014-04-18T14:18:00.000Z",
            "profileId":"admin",
            "eventName":"Men's clothing publish",
            "id":"100002",
            "eventType":1
        }
    ]
}

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| |------------------|------------------| |10002|Invalid value [ {1} ] for parameter: {0}.|

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