POST apioauth/matrixv2/smartviewpdf
Queue a pdf to be created and emailed
Request Information
URI Parameters
None.
Body Parameters
CreateSmartviewPdfRequestName | Description | Type | Additional information |
---|---|---|---|
PdfId |
The id of the pdf to create |
integer |
None. |
Customer |
The name of the customer the pdf is for |
string |
None. |
The email address where the pdf will be sent |
string |
None. |
|
StringParameters |
The string parameters |
Dictionary of string [key] and Collection of string [value] |
None. |
IntegerParameters |
Integer parameters |
Dictionary of string [key] and Collection of integer [value] |
None. |
DecimalParameters |
Decimal parameters |
Dictionary of string [key] and Collection of decimal number [value] |
None. |
DateTimeParameters |
DateTime parameters |
Dictionary of string [key] and Collection of date [value] |
None. |
Request Formats
application/json, text/json
Sample:
{ "PdfId": 1, "Customer": "sample string 2", "Email": "sample string 3", "StringParameters": { "sample string 1": [ "sample string 1", "sample string 2" ], "sample string 2": [ "sample string 1", "sample string 2" ] }, "IntegerParameters": { "sample string 1": [ 1, 2 ], "sample string 2": [ 1, 2 ] }, "DecimalParameters": { "sample string 1": [ 1.1, 2.1 ], "sample string 2": [ 1.1, 2.1 ] }, "DateTimeParameters": { "sample string 1": [ "2025-04-27T15:31:54.1105087+00:00", "2025-04-27T15:31:54.1105087+00:00" ], "sample string 2": [ "2025-04-27T15:31:54.1105087+00:00", "2025-04-27T15:31:54.1105087+00:00" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A collection of SmartviewPDFResponses
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |