getPublishingHistoricalChanges
get
/ccadmin/v1/publishingHistory/{id}/changes
Get Publishing Historical Changes. Get a list of high level publishing change items.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The ID of the publishing historical to retrieve.
Query Parameters
-
limit: integer
Limit of number of change items.
-
q: string
Query String used to limit change items.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPublishingHistoricalChanges_response
Type:
Show Source
object
-
items:
array items
Items of publishing changes.
-
limit:
integer
Limit of number of change items.
-
offset:
integer
Offset.
-
sort:
array sort
Sort information of the change items.
-
totalResults:
integer
Total number of change items.
Nested Schema : items
Type:
Show Source
object
-
assetId:
string
Asset Id of the publishing change.
-
assetType:
string
Asset type of the publishing change.
-
assetTypeDisplayName:
string
Asset type display name of the publishing change.
-
author:
string
Last author ID of publishing change.
-
authorProfileType:
string
The profile type of the author
-
authors:
array authors
Array of authors of the publishing change with format as: author'ID:author's first name,author's last name.
-
changeDetails:
array changeDetails
Change Details.
-
changeTime:
string
Changing time of the publishing change.
-
changeType:
integer
Change type of the publishing change. 0: UPDATE, 1: DELETE, 2: CREATE.
-
displayName:
string
Display name of the publishing change.
-
firstName:
string
First Name of the last author of the publishing change.
-
id:
string
Id of the publishing change.
-
lastName:
string
Last Name the of the last author of the publishing change.
-
subsystem:
string
The subsystem involved in the change
Nested Schema : items
Type:
Show Source
object
-
author:
string
Author ID of the publishing change.
-
changeTime:
string
Changing time of the publishing change.
Nested Schema : items
Type:
Show Source
object
-
order:
string
Order of change items.
-
property:
string
Property of the change items say display name.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":250,
"sort":[
{
"property":"displayName",
"order":"asc"
}
],
"items":[
{
"lastName":"User",
"authorProfileType":"adminUI",
"displayName":"The Girl with the Dragon Tattoo",
"author":"admin",
"changeType":0,
"subsystem":"OCCS-Admin",
"assetType":"product",
"changeDetails":[
{
"changeTime":"2022-03-03T19:01:32.000Z",
"author":"admin"
},
{
"changeTime":"2022-03-03T19:01:39.000Z",
"author":"admin"
},
{
"changeTime":"2022-03-03T19:01:44.000Z",
"author":"admin"
}
],
"changeTime":"2022-03-03T19:01:44.000Z",
"assetTypeDisplayName":"Product: Base Product",
"firstName":"Admin",
"assetId":"Product_36Exy",
"id":"change30004",
"authors":[
"admin:User,Admin"
]
}
]
}
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|
|------------------|------------------|
|31402|Internal Error|
|31410|No publishing historical found with id: {0}|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
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
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code