1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Publishing Change Lists

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
changeListId
Type: string
Required: true
Query Parameters
changes
Type: string
Type of dependencies. One of all, dependencies or original.
detail
Type: 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
Type: string
The asset language of the request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getPublishingDependencies_response
Nested Schema : items
Type: array
Items of publish changes.
Nested Schema : sort
Type: array
Sort information of the publishing changes.
Nested Schema : items
Type: object
Nested Schema : authors
Type: array
Array of authors of publishing changes with format as: author'repository id:author's first name,author's last name.
Nested Schema : changeDetails
Type: array
Change Details.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example 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":"",
            "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}.|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "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": "",
    "authors": [
      "admin:Amber,Admin",
      "admin:Weber,Damon"
    ]
  }]
}