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

getPublishingChanges

get

/ccadmin/v1/publishingChanges

Get Publishing Changes. Get a list of publishing change items. Can be used to obtain high level items only and all items

Request

Supported Media Types
  • application/json
Query Parameters
detail
Type: string
String used to indicate whether to return full list of change items or high level only. "full" value mean all items. Otherwise it will be high level items only.
excludeCatalogConfig
Type: string
excludes the Catalog Configuration item (if any) from the response
excludeDesignItem
Type: string
excludes the Design item (if any) from the response
limit
Type: integer
Limit of number of change items.
q
Type: string
Query String used to limit publishing changes.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getPublishingChanges_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,
    "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":"2014-03-10T13:06:06.075Z",
            "firstName":"Admin",
            "componentPath":"/atg/commerce/catalog/ProductCatalog",
            "assetId":"catMen",
            "repositoryId":"change30449",
            "id":"change30449",
            "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| |------------------|------------------| |31035|Internal Error| |10002|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,
  "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": "2014-03-10T13:06:06.075Z",
    "firstName": "Admin",
    "componentPath": "/atg/commerce/catalog/ProductCatalog",
    "assetId": "catMen",
    "repositoryId": "change30449",
    "id": "change30449",
    "parentAssetType": "",
    "authors": [
      "admin:Amber,Admin",
      "admin:Weber,Damon"
    ]
  }]
}