REST API for Oracle Commerce Cloud December 2017

upgradeCurrentVersion

post

/ccadmin/v1/jsframeworkadmin/upgradeVersion

Upgrade Current Version. Upgrades the the current Storefront Javascript framework to the latest version.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : upgradeCurrentVersion_request

Example

POST /ccadminui/v1/jsframeworkadmin/upgradeVersion

Properties

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : upgradeCurrentVersion_response

Properties

currentVersion: Type: string

The storefront javascript framework version currently running.
previousVersion: Type: string

The previous version storefront javascript framework.
storefrontVersion: Type: string

The latest version of the storefront javascript framework available.
success: Type: boolean

whether the rollback was successful.

Example application/json


{
    "storefrontVersion":"17.1",
    "success":true,
    "previousVersion":"16.6",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/jsframeworkadmin/upgradeVersion"
        }
    ],
    "currentVersion":"17.1"
}

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| |------------------|------------------| |30102|Unable to upgrade to the previous version Storefront framework| |30105|No site found| |30104|Unable to upgrade as the framework is already the latest version|

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:

POST /ccadminui/v1/jsframeworkadmin/upgradeVersion

Sample Response Payload returned by endpoint:

{
  "storefrontVersion": "17.1",
  "success": true,
  "previousVersion": "16.6",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/jsframeworkadmin/upgradeVersion"
  }],
  "currentVersion": "17.1"
}