REST API for Oracle Commerce Cloud December 2017

getPublishChanges

get

/ccadmin/v1/publish/changes

Get Publish Changes. Get a list of publishing change items. Optionally takes the x-ccasset-language header to get translated content in another language. Deprecated.

Request

Supported Media Types

application/json

Query Parameters

filterString: Type: string

String used to filter the returned change items.

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 : getPublishChanges_response

Properties

items: Type: array items

Additional Properties Allowed:

Items of publish changes.
limit: Type: integer

Limit of number of changes.
offset: Type: integer

Offset.
sort: Type: array sort

Additional Properties Allowed:

Sort information of the publishing changes.
total: Type: integer

Total number of changes published. Deprecated.
totalResults: Type: integer

Total number of changes published.

Nested Schema : items

Type: array

Items of publish changes.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: array

Sort information of the publishing changes.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

assetId: Type: string

Asset Id of publishing changes.
assetType: Type: string

Asset type of publishing changes.
assetTypeDisplayName: Type: string

Asset type display name of publishing changes.
author: Type: string

Author of publishing changes.
changeTime: Type: string

Changing time of publishing changes.
changeType: Type: integer

Change type of publishing changes. 0: UPDATE, 1: DELETE, 2: CREATE.
componentPath: Type: string

Component path of publishing changes.
displayName: Type: string

Display name of publishing chnages.
firstName: Type: string

First Name of the Author of publishing changes.
id: Type: string

Id of publishing changes.
itemType: Type: string

Item type of publishing changes.
lastName: Type: string

Last Name the of Author of publishing changes.
parentAssetType: Type: string

Parent asset type of publishing changes.
repositoryId: Type: string

Repository Id of publishing changes.

Nested Schema : items

Type: object

Properties

order: Type: string

Order of publishing changes.
property: Type: string

Property of changes say display name.

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",
            "assetTypeDisplayName":"Collection",
            "changeTime":"2014-03-10T13:06:06.075Z",
            "firstName":"Admin",
            "componentPath":"/atg/commerce/catalog/ProductCatalog",
            "assetId":"catMen",
            "repositoryId":"change30449",
            "id":"change30449",
            "parentAssetType":""
        }
    ]
}

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| |------------------|------------------| |50011|{0} is a restricted property to use for sorting| |50012|{0} is an invalid sort property for this operation| |10002|Invalid value [ {1} ] for parameter: {0}.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: 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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

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",
    "assetTypeDisplayName": "Collection",
    "changeTime": "2014-03-10T13:06:06.075Z",
    "firstName": "Admin",
    "componentPath": "/atg/commerce/catalog/ProductCatalog",
    "assetId": "catMen",
    "repositoryId": "change30449",
    "id": "change30449",
    "parentAssetType": ""
  }]
}