getPublishingHistoricals
get
/ccadmin/v1/publishingHistory
Get Publishing History. Get a list of publishing historical items.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
Limit of number of publishing historical items.
-
q(optional): string
Query String used to limit publishing historical items.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPublishingHistoricals_response
Type:
Show Source
object
-
items(optional):
array items
Items of publishing historical.
-
limit(optional):
integer
Limit of number of publishing historical items.
-
offset(optional):
integer
Offset.
-
sort(optional):
array sort
Sort information of the publishing historical items.
-
totalResults(optional):
integer
Total number of publishing historical items.
Nested Schema : items
Type:
Show Source
object
-
authors(optional):
array authors
Array of authors of the publish changes with format as: author'ID:author's first name,author's last name.
-
endTime(optional):
string
End time of the publish
-
eventName(optional):
string
Event name of the publish
-
id(optional):
string
ID of publishing historical.
-
numberOfHistoricalChanges(optional):
string
Number of high level changes
-
operationType(optional):
string
Operation Type of publishing historical: selective_publish or publish.
-
publishInitiator(optional):
string
Publish initiator with format as: initiator'ID:initiator's first name,initiator's last name.
-
publishInitiatorProfileType(optional):
string
Profile type of the publish initiator
-
startTime(optional):
string
Start time of the publish.
-
worksetId(optional):
string
Workset name of the publish
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Order of publishing historical items.
-
property(optional):
string
Property of publishing historical say endTime.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":250,
"sort":[
{
"property":"endTime",
"order":"desc"
}
],
"items":[
{
"publishInitiator":"admin:User,Admin",
"worksetName":"default",
"eventName":"default",
"numberOfHistoricalChanges":1,
"startTime":"2022-03-03T19:02:35.000Z",
"operationType":"selective_publish",
"id":"publish30002",
"endTime":"2022-03-03T19:02:45.356Z",
"publishInitiatorProfileType":"adminUI",
"authors":[
"admin:User,Admin"
],
"worksetId":"default"
}
]
}
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|
|------------------|------------------|
|31400|Internal Error|
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