publishChangeLists
post
/ccadmin/v1/publishingChangeLists/publish
Publish Change Lists. Start or schedule a publish operation.
Request
Supported Media Types
- application/json
Root Schema : publishChangeLists_request
Type:
Show Source
object
-
changeListId(optional):
string
Change list ID to represent the list of change item IDs to use for selective publishing
-
dateTime(optional):
string
Timestamp (ISO 8601) to schedule the publish operation. Not valid when operationType is selective_publish
-
eventName(optional):
string
An optional name for the selective publishing event
-
operationType(optional):
string
Type of publish operation to perform. One of publish or selective_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).
-
worksetId(optional):
string
Workset ID to represent the workset Id to use for selective publishing. If worksetId is specified, changelistId will be ignored.
Example:
POST /ccadmin/v1/publishingChangeLists/publish
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : publishChangeLists_response
Type:
Show Source
object
-
publishRunning(optional):
boolean
Tells whether publish is running.
-
statusMessage(optional):
string
Status Message of publish.
Example Response (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.|
|31047|full_publish is not a valid operationType. Use publish or selective_publish.|
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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