Jump to

• Request
• Response

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.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : getAgentCurrentVersionDetails_200_response

Type: object

Show Source

• 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.

{
    "properties":{
        "currentAgentVersion":{
            "description":"The Agent version that is currently running.",
            "type":"string"
        },
        "lastAgentUpdate":{
            "description":"A timestamp indicating when Agent was last updated.",
            "type":"string"
        },
        "previousAgentVersion":{
            "description":"The previous version, if there is one.",
            "type":"string"
        },
        "success":{
            "description":"Determines if the attempt to retrieve the Agent version was successful.",
            "type":"boolean"
        },
        "agentVersion":{
            "description":"The Agent version that is currently running.",
            "type":"string"
        },
        "overrideAgentVersion":{
            "description":"The agent version that overrides the latest version.",
            "type":"string"
        }
    }
}

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:

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:

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