GET /content/{contentpath}

Retrieves the requested content from the platform.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

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

https://{hostname}/content/{contentpath}

Back to top

Sample Request

The example below shows a request for one of the online help documents on the platform.

Request URL #1

Returns a page from the site help.

https://api.acmepaymentscorp.com/content/home/learnmore/create_your_app.htm

Request URL #2

Returns the index page from the API documentation for the specified API.

Note: in the below, the ID in the path is the APIID.

https://www.acmepaymentscorp.com/content/api/916b7cf8-c29e-4cd0-8e76-93fc64e48617.acmepaymentscorp/documents/index.htm

Sample request headers

Host: {hostname}

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 Not necessary for this operation. Since platform content is being returned, the URI for the resource is all that's needed. The platform already has the content type for the requested resource.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
path Path string Required The path and filename for the content resource being requested.
locale Query string Optional The locale applicable to the user requesting the content. For more information, see Supporting Multiple Languages.

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: application/json

HTTP/1.1 200 OK
Content-Type:  text/html;charset=ISO-8859-1
Date: Tue, 26 Apr 2016 13:33:46 GMT

Sample response body

The response is the document requested.

Back to top

Response Headers

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

Header Description
Content-Type The content-type value varies according to the nature of the content requested.

Back to top

Response Body

The response body is the content requested in the request URL (the complete content file).

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