GET | /Reports/{ReportID}/PDF/Download | Retrieves PDF of the selected report. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReportID | path | string | No | |
ReportParameters | query | List<ReportParameter> | No | |
AsAttachment | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | int | No | |
StatusCode | form | HttpStatusCode | No | |
StatusDescription | form | string | No | |
ContentType | form | string | No | |
Headers | form | Dictionary<string, string> | No | |
Cookies | form | List<Cookie> | No | |
Response | form | Object | No | |
ResponseFilter | form | IContentTypeWriter | No | |
RequestContext | form | IRequest | No | |
PaddingLength | form | int | No | |
ResultScope | form | Func<IDisposable> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OriginalRequest | form | Object | No | |
Response | form | IResponse | No | |
OperationName | form | string | No | |
Verb | form | string | No | |
RequestAttributes | form | RequestAttributes | No | |
RequestPreferences | form | IRequestPreferences | No | |
Dto | form | Object | No | |
ContentType | form | string | No | |
IsLocal | form | bool | No | |
UserAgent | form | string | No | |
Cookies | form | IDictionary<string, Cookie> | No | |
ResponseContentType | form | string | No | |
HasExplicitResponseContentType | form | bool | No | |
Items | form | Dictionary<string, Object> | No | |
Headers | form | NameValueCollection | No | |
QueryString | form | NameValueCollection | No | |
FormData | form | NameValueCollection | No | |
UseBufferedStream | form | bool | No | |
RawUrl | form | string | No | |
AbsoluteUri | form | string | No | |
UserHostAddress | form | string | No | |
RemoteIp | form | string | No | |
Authorization | form | string | No | |
IsSecureConnection | form | bool | No | |
AcceptTypes | form | string[] | No | |
PathInfo | form | string | No | |
OriginalPathInfo | form | string | No | |
ContentLength | form | long | No | |
Files | form | IHttpFile[] | No | |
UrlReferrer | form | Uri | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OriginalResponse | form | Object | No | |
Request | form | IRequest | No | |
StatusCode | form | int | No | |
StatusDescription | form | string | No | |
ContentType | form | string | No | |
Dto | form | Object | No | |
UseBufferedStream | form | bool | No | |
IsClosed | form | bool | No | |
KeepAlive | form | bool | No | |
HasStarted | form | bool | No | |
Items | form | Dictionary<string, Object> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcceptsGzip | form | bool | No | |
AcceptsDeflate | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
FileName | form | string | No | |
ContentLength | form | long | No | |
ContentType | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Reports/{ReportID}/PDF/Download HTTP/1.1 Host: api.jiwa.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {Unable to show example output for type 'IHttpResult' using the custom 'csv' filter}Cannot create an instance of an interface.