Jump to

• Request
• Response

upgradeAgentCurrentVersion

post

/ccadmin/v1/jsframeworkadmin/upgradeAgentVersion

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

Request

Supported Media Types

• application/json

Body ()

Root Schema : upgradeAgentCurrentVersion_request

Show Source

{
    "properties":{
    },
    "example":"POST /ccadminui/v1/jsframeworkadmin/upgradeAgentVersion"
}

Example:

POST /ccadminui/v1/jsframeworkadmin/upgradeAgentVersion

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : upgradeAgentCurrentVersion_response

Type: object

Show Source

• agentVersion(optional): string
  The latest version of the Agent javascript framework available.
• currentVersion(optional): string
  The Agent javascript framework version currently running.
• previousVersion(optional): string
  The previous version Agent javascript framework.
• success(optional): boolean
  whether the operation was successful.
• UpgradeMessage(optional): string
  Additional Info about the Upgrade. Usually indicates if the Agent is already on latest Version.

{
    "properties":{
        "success":{
            "description":"whether the operation was successful.",
            "type":"boolean"
        },
        "previousVersion":{
            "description":"The previous version Agent javascript framework.",
            "type":"string"
        },
        "agentVersion":{
            "description":"The latest version of the Agent javascript framework available.",
            "type":"string"
        },
        "UpgradeMessage":{
            "description":"Additional Info about the Upgrade. Usually indicates if the Agent is already on latest Version.",
            "type":"string"
        },
        "currentVersion":{
            "description":"The Agent javascript framework version currently running.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "success":true,
    "previousVersion":"19.5.4-SNAPSHOT",
    "agentVersion":"19.5.6-SNAPSHOT",
    "links":[
        {
            "rel":"self",
            "href":"/ccadminui/v1/jsframeworkadmin/upgradeAgentVersion"
        }
    ],
    "currentVersion":"19.5.6-SNAPSHOT"
}

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

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top