Upgrade Agent current version
post
/ccadmin/v1/jsframeworkadmin/upgradeAgentVersion
Upgrades the current Agent storefront JavaScript framework to the latest version in order to make use of features from the newest release.
In order for this upgrade to take effect, you must publish said change after calling the endpoint.
In order for this upgrade to take effect, you must publish said change after calling the endpoint.
This endpoint only is applicable if a newer version exists. In order to determine the current Agent framework status, the Retrieve Current Agent Version endpoint should be used.
Note:This endpoint is not supported for use in the Open Storefront Framework.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : upgradeAgentCurrentVersion_200_response
Type:
Show Source
object
-
agentVersion(optional):
string
The version of the Agent that is currently running.
-
currentAgentVersion(optional):
string
The Agent version that is currently running.
-
lastAgentUpdate(optional):
string
A timestamp indicating when Agent was last updated.
-
overrideAgentVersion(optional):
string
The agent version that overrides the latest version.
-
previousAgentVersion(optional):
string
The previous version, if there was one
-
success(optional):
boolean
Determines if the attempt to retrieve the agent version was successful
Example Response (application/json)
{
"currentAgentVersion":"20.2.4",
"lastAgentUpdate":"2020-05-21T10:56:31.349Z",
"previousAgentVersion":"20.2.3",
"success":true,
"agentVersion":"20.2.4",
"overrideAgentVersion":"",
"links":[
{
"rel":"self",
"href":"ccadminui/v1/jsframeworkadmin/upgradeAgentVersion"
}
]
}
Default Response
The following internal error codes are thrown by this API when the request fails in Commerce:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
30102 | Unable to upgrade. | See returned error messages for more information. |
30105 | Site not found. | Ensure you specify a valid site ID. |
30105 | Site not found. | Ensure you specify a valid site ID. |
96028 | Failed to upgrade agent version. | Ensure there is a valid existing version. |
The error response:
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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