GET /ui/apps/atmosphere/{version}/{path:resources/.*}

Returns the platform resource specified in the path.

Note: getting resources via the UI Application service is in some cases similar to getting resources via the Console Resource service (see ConsoleResource Service: Overview). There are the following differences:

  • When you use the Console Resource service, resources are automatically cached for 1 hour. When you use the UI Application service, resources are cached for 30 days.
  • Using the Console Resource service with atmosphere as the value for the application is the same as using the UI Application service, which only supports atmosphere as the application value (ui/apps/atmosphere).

Authorization Roles/Permissions: No permission needed. Anyone can run this operation.

Note: The CSRF header is never required for this operation, regardless of platform settings.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

{protocol}://{hostname}/ui/apps/atmosphere/{version}/{path:resources/.*}

Back to top

Sample Request

The example below shows a request for the custom.less file for this instance of the developer portal.

Request URL

http://acmepaymentscorp.com/ui/apps/acmepaymentscorp/_VZDDEgXYVpd_dBFe6W7zNnQ/resources/theme/default/less/custom_template.less?download=true&theme=default

Sample request headers

None needed.

Sample request body

Not applicable.

Back to top

Request Headers

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

None.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
version Query String Required The ScriptVersionKey; the unique ID for the release version.
path Path String Required The path for the content being retrieved. Include the path from the /resources/ folder downwards.
dynamic Query Boolean Optional Indicates whether the upload file content includes dynamic placeholders to be replaced with current values valid on the platform. Default: false. For possible values, see Console Resource dynamic variable values.
download Query Boolean Optional Indicates whether the content is being downloaded. Default: false.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the requested content.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/html
Content-Disposition: attachment;filename="custom.less"

Sample response body

The content below has been abbreviated for display purposes.

/**
 *  Commonly used variables to customize styles
 *  Tenant: Acmepaymentscorp *  Theme: Default  
 */

// base color, often used for navbar (left or top) background color, link text color, button background color, etc 
// @main-color: #2683b4;

// when base color is used as a background, what's the text color on top? 
// @inverse-color: #fff;

// the main color of the entire page's background 
// @canvas-color: @inverse-color;

// color of link text
// @link-color: @main-color;
...

Back to top

Response Headers

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

None.

Back to top

Response Body

The response body is the requested resource..

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