GET /ui/apps/{application}/scriptversionkey

Returns the current script version key value.

Authorization Roles/Permissions: None required. Anyone can run this operation.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

{protocol}://ui/apps/{application}/scriptversionkey

Back to top

Sample Request

The examples below show a requests for the Script Version Key.

Request URL #1

Returns ScriptVersionKey for Default Theme (default name is used).

http://www.acmepaymentscorp.com/ui/apps/acmepaymentscorp/scriptversionkey?property.theme=default

Request URL #2

ReturnsScriptVersionKey for Simple Dev theme.

http://www.acmepaymentscorp.com/ui/apps/acmepaymentscorp/scriptversionkey?property.theme=simpledev

Request URL #3

Returns ScriptVersionKey for OAuth Provider.

http://www.acmepaymentscorp.com/ui/apps/oauthauz/scriptversionkey

Sample request headers

Accept: text/plain

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
application Path string Optional The theme for which the script version is being requested. Valid values are the theme names set up for the platform.
property.theme Query string Optional

Depends on the value of the application parameter:

  • If the value for application is oauthauz, property.theme is not needed.
  • If the value for application is atmosphere, use property.theme with the theme for which you want to get the script version key. Use the theme names as they were set up for your installation. For example: property.theme=default or property.theme=simpledev.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the script version key.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Accept: text/plain
Expires: Wed, 04 Nov 2015 13:51:02 GMT

Sample response body

UVmTjU1aOKmfek07sZrsKA

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
ScriptVersionKey string The ScriptVersionKey; the unique ID for the release version.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics