REST API for Oracle Commerce Cloud December 2017

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.

Body

Root Schema : getPublishSchedule_response

Properties

items: Type: array items

Additional Properties Allowed:

Items of scheduled publishing.
limit: Type: integer

Limit of number of scheduled publishes.
offset: Type: integer

offset.
sort: Type: array sort

Additional Properties Allowed:

Sort information of the scheduled publishing.
total: Type: integer

Total number of scheduled publishes.

Nested Schema : items

Type: array

Items of scheduled publishing.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: array

Sort information of the scheduled publishing.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

dateTime: Type: string

Date and time of scheduled publish.
id: Type: integer

Id of scheduled publish.
maxWaitMinutes: Type: string

The maximum number of minutes to wait for the publishing lock. A null value means wait up to the default number of minutes (30)
profileId: Type: string

Profile Id of scheduled publish.

Nested Schema : items

Type: object

Properties

order: Type: string

Order of publish.
property: Type: string

Property of publish.

Example application/json


{
    "total":1,
    "offset":0,
    "limit":1,
    "sort":[
        {
            "property":"dateTime",
            "order":"asc"
        }
    ],
    "items":[
        {
            "dateTime":"2014-03-18T14:18:00.000Z",
            "maxWaitMinutes":30,
            "profileId":"admin",
            "id":"100002"
        }
    ]
}

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

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:

{
  "total": 1,
  "offset": 0,
  "limit": 1,
  "sort": [{
    "property": "dateTime",
    "order": "asc"
  }],
  "items": [{
    "dateTime": "2014-03-18T14:18:00.000Z",
    "maxWaitMinutes": 30,
    "profileId": "admin",
    "id": "100002"
  }]
}