GET api/preview/{docReference}?width={width}&height={height}&rotation={rotation}&quality={quality}&inline={inline}
Gets a temporary document stored by document generation, so that it can be previewed. Processes this preview API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| docReference |
The doc reference value supplied with the request. |
string |
Required |
| width |
The width value supplied with the request. |
string |
None. |
| height |
The height value supplied with the request. |
string |
None. |
| rotation |
The rotation value supplied with the request. |
string |
None. |
| quality |
The quality value supplied with the request. |
string |
None. |
| inline |
The inline value supplied with the request. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version |
The version value. |
Version |
None. |
| Content |
The content value. |
HttpContent |
None. |
| StatusCode |
The status code classification. |
HttpStatusCode |
None. |
| ReasonPhrase |
The reason phrase value. |
string |
None. |
| Headers |
The collection of headers. |
Collection of Object |
None. |
| RequestMessage |
The request message value. |
HttpRequestMessage |
None. |
| IsSuccessStatusCode |
Indicates whether this item is success status code. |
boolean |
None. |