REST API for Oracle Commerce Cloud December 2017

storePublishingChangeList

post

/ccadmin/v1/publishingChangeLists

Store Publishing Change List. Store a list of change item IDs for later dependency calculations or selective publishing

Request

Supported Media Types

application/json

Body Parameter

Root Schema : storePublishingChangeList_request

Example


{
    "changeItemIds":[
        "ID1",
        "ID2",
        "ID3"
    ]
}

Properties

changeItemIds: Type: array changeItemIds

Required: true

Additional Properties Allowed:

Array of change item IDs to store.

Nested Schema : changeItemIds

Type: array

Array of change item IDs to store.

Items

Type: string

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : storePublishingChangeList_response

Properties

changeListId: Type: string

ID corresponding to the change item lists which can be used to invoke getPublishing endpoint.

Example application/json


{
    "changeListId":"N2ECA3RrG1jLYZjN4Q6XTNrkjc_10000"
}

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| |------------------|------------------| |31034|List of input change item IDs not found|

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

{"changeItemIds": [
  "ID1",
  "ID2",
  "ID3"
]}

Sample Response Payload returned by endpoint:

{"changeListId": "N2ECA3RrG1jLYZjN4Q6XTNrkjc_10000"}