Preview Ui REST Endpoint

GET api.ashx/v2/ui/preview.{json|xml}

Renders preview HTML for a url

Scopes

Utilities › Read View HTML utilities.viewhtml.readonly

Request Parameters

Name	Type	Location	Description	Required	Default
adjustToContainer	bool	Query String	When true, the HTML is re-rendered on window resize to fit within the max available space in the parent container.	Optional	false
height	int	Query String	Height of the url content	Optional	100
outputIsPersisted	bool	Query String	When the output is not persisted, direct links to CFS file URLs can be rendered. Otherwise, the generic CFS URL is rendered which results in a redirect.	Optional	false
url	string	Query String	Url	Required
width	int	Query String	Width of the url content	Optional	100

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/ui/preview.json?url=url',
	data: { 
		'url': 'url'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "Html": "html",
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Html>html</Html>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

Recommended