Retrieve current Agent version
get
/ccadmin/v1/jsframeworkadmin/agentVersion
Retrieves the version information for the Agent JavaScript framework. This endpoint can be used to check if a rollback or version upgrade is possible for the version of the Agent JavaScript framework currently in use.
Note: This endpoint is not supported in the Open Storefront Framework.
Note: This endpoint is not supported 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 : getAgentCurrentVersionDetails_200_response
Type:
Show Source
object
-
agentVersion(optional):
string
The Agent version 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 is one.
-
success(optional):
boolean
Determines if the attempt to retrieve the Agent version was successful.
Example Response (application/json)
{
"currentAgentVersion":"20.2.3",
"lastAgentUpdate":"2020-05-21T10:56:31.349Z",
"previousAgentVersion":"",
"success":true,
"agentVersion":"20.2.3",
"overrideAgentVersion":"",
"links":[
{
"rel":"self",
"href":"cadminui/v1/jsframeworkadmin/agentVersion"
}
]
}
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 |
---|---|---|
30105 | Site not found. | Ensure you specify a valid site ID. |
96026, 96027 | Configuration issue. | See returned error messages for more information. |
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