getPublishingDependencies
get
/ccadmin/v1/publishingChangeLists/{changeListId}
Get Publishing Dependencies. Get a list of publishing change items that are dependent on the input items identified by the {changeListId}. Output includes the input items. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
changes(optional): string
Type of dependencies. One of all, dependencies or original.
-
detail(optional): string
Level of dependencies. By default, only high level change items are returned. If value is full, both high level and low level change items are returned. And if value is full, param "changes" setting will be overridden to default value (all).
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPublishingDependencies_response
Type:
Show Source
object-
changeListId(optional):
string
Change list ID corresponding to the input IDs which can be used to invoke publishingChangeLists/publish endpoints.
-
items(optional):
array items
Items of publish changes.
-
limit(optional):
integer
Limit of number of change items.
-
offset(optional):
integer
Offset.
-
sort(optional):
array sort
Sort information of the publishing changes.
-
total(optional):
integer
Total number of dependent change items.
-
totalResults(optional):
integer
Total number of dependent change items.
Nested Schema : items
Type:
Show Source
object-
assetId(optional):
string
Asset Id of publishing changes.
-
assetType(optional):
string
Asset type of publishing changes.
-
assetTypeDisplayName(optional):
string
Asset type display name of publishing changes.
-
author(optional):
string
Last author of publishing changes.
-
authorProfileType(optional):
string
The profile type of the changelist author
-
authors(optional):
array authors
Array of authors of publishing changes with format as: author'repository id:author's first name,author's last name.
-
changeDetails(optional):
array changeDetails
Change Details.
-
changeTime(optional):
string
Changing time of publishing changes.
-
changeType(optional):
integer
Change type of publishing changes. 0: UPDATE, 1: DELETE, 2: CREATE.
-
componentPath(optional):
string
Component path of publishing changes.
-
displayName(optional):
string
Display name of publishing chnages.
-
firstName(optional):
string
First Name of the last author of publishing changes.
-
id(optional):
string
Id of publishing changes.
-
itemType(optional):
string
Item type of publishing changes.
-
lastName(optional):
string
Last Name the of the last author of publishing changes.
-
parentAssetType(optional):
string
Parent asset type of publishing changes.
-
repositoryId(optional):
string
Repository Id of publishing changes.
-
scheduledPublishItem(optional):
array scheduledPublishItem
Scheduled publish event information.
-
subsystem(optional):
string
The subsystem involved in the change
Nested Schema : items
Type:
Show Source
object-
author(optional):
string
Author of publishing changes.
-
changeTime(optional):
string
Changing time of publishing changes.
-
description(optional):
string
Coming for embeded item of "Catalog Configuration" and "Design" items.
-
repositoryId(optional):
string
Repository Id of change detail.
Nested Schema : items
Type:
Show Source
object-
dateTime(optional):
string
Time of scheduled publish event.
-
eventName(optional):
string
Name of scheduled publish event.
-
eventType(optional):
number
Type of scheduled publish event (0 - full, 1 - partial)
-
firstName(optional):
string
First name of person who initiated the scheduled publish event.
-
lastName(optional):
string
Last name of person who initiated the scheduled publish event.
-
profileid(optional):
string
User id of person who initiated the scheduled publish event.
-
repositoryId(optional):
string
Repository Id of scheduled publish event.
Nested Schema : items
Type:
Show Source
object-
order(optional):
string
Order of publishing changes.
-
property(optional):
string
Property of changes say display name.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":1,
"changeListID":[
"string",
"change list Id which can be used for scheduling a selective publish for the items in this list."
],
"sort":[
{
"property":"displayName",
"order":"asc"
}
],
"items":[
{
"lastName":"Amber",
"itemType":"repository",
"author":"admin",
"displayName":"Men",
"changeType":0,
"assetType":"category",
"changeDetails":[
{
"changeTime":"2016-05-10T13:06:06.075Z",
"author":"admin",
"repositoryId":"100005"
}
],
"assetTypeDisplayName":"Collection",
"changeTime":"2016-05-10T13:06:06.075Z",
"firstName":"Admin",
"componentPath":"/atg/commerce/catalog/ProductCatalog",
"assetId":"catMen",
"repositoryId":"change44444",
"id":"change44444",
"parentAssetType":"",
"scheduledPublishItem":{
"dateTime":"2018-01-26T08:00:00.000Z",
"firstName":"Admin",
"lastName":"User",
"profileId":"admin",
"eventName":"Men's clothing publish",
"id":"900001",
"eventType":1
},
"authors":[
"admin:Amber,Admin",
"admin:Weber,Damon"
]
}
]
}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|
|------------------|------------------|
|31032|Internal Error|
|31033|Invalid value [ {1} ] for parameter: {0}.|
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:
arrayAn 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