REST API for Oracle Commerce Cloud December 2017

publish

post

/ccadmin/v1/publish

Publish. Start or schedule a publish operation. Deprecated.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : publish_request

Example

POST /ccadmin/v1/publish

Properties

dateTime: Type: string

Timestamp to schedule the publish operation. Not valid when operationType is selective_publish
maxWaitMinutes: Type: integer

Number of minutes to wait for the publishing lock that may be held by another long-running operation, such as an import.
operationType: Type: string

Type of publish operation to perform. one of publish, full_publish or selective_publish
tokenID: Type: string

TokenID to represent the list of change item IDs to use for selective publishing

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : publish_response

Properties

publishRunning: Type: boolean

Tells wheather publish is running.
statusMessage: Type: string

Status Message of publish.

Example application/json


{
    "publishRunning":true,
    "statusMessage":"A publish has been successfully initiated."
}

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| |------------------|------------------| |31021|A scheduled publish already exists with the specified date and time: {0}| |31020|The scheduled publish date and time: {0} is invalid.| |31022|An internal error occurred while scheduling a publishing operation.| |31033|Invalid input error.| |31030|Could not start publish operation. Another publish operation is currently in progress.|

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:

POST /ccadmin/v1/publish

Sample Response Payload returned by endpoint:

{
  "publishRunning": true,
  "statusMessage": "A publish has been successfully initiated."
}