PrintTable
HTTP Request Format
POST api/PrintTable
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/PrintTable
Description
The PrintTable REST API command sends the Table View to the printer and allows you to modify Table View printing options. One or more of the optional attributes may be included in the command, but none are required.
Parameters
All parameters are optional
| JSON Parameters | Body Format | Description |
|---|---|---|
| BottomMargin | "BottomMargin" : "50" | Bottom margin in inches. Must be a value between 0-100 |
| LeftMargin | "LeftMargin" : "50" | Left margin in inches. Must be a value between 0-100 |
| RightMargin | "RightMargin" : "50" | Right margin in inches. Must be a value between 0-100 |
| TopMargin | "TopMargin" : "50" | Top margin in inches. Must be a value between 0-100 |
| Orientation | "Orientation" : "LANDSCAPE" | Orientation of image. Options are "LANDSCAPE" or "PORTRAIT" |
| Header | "Header" : "Example Table Title" | String header for the table |
| Footer | "Footer" : "Example Table Footer" | String footer for the table |
| PageWidth | "PageWidth" : "5" | Width of printout in full pages. Must be an integer ≥ 1 |
Examples
Prints the Table View three full pages wide in a landscape orientation with the header "Assignment Table View"
POST api/PrintTable
Body:
{
"PageWidth" : "3",
"Orientation" : "LANDSCAPE",
"Header" : "Assignment Table View"
}
Return Message
If activated, a standard response for a successful HTTP response shall appear.
Group Membership
This command belongs to the following group(s):
Version
12.3
