ServerPrinters

Queryable, Introduced in version 2.52

GET https://localhost:8001/sv/001.1/api/v1/Common/ServerPrinters

Represents a server printer that can be used to print documents via the MONITOR server.

GUID

33D557AF-A625-45EF-87FB-0B07DED04BFD

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the server printer.
Number String The human readable identifier of the server printer.

  • Max length is 20
  • Unique
Description String The translated description of the server printer.
Name String The name of the printer that the server printer connects to.

  • Max length is 255
  • Not nullable
Orientation Int32 The printout orientation to apply to the server printer.

  • Portrait: 0
  • Landscape: 1
  • Auto: 2
DuplexMode Int32 The duplex mode to apply to the server printer.

  • None: 0
  • LongEdge: 1
  • ShortEdge: 2
PaperSize Int32 The paper size to apply to the server printer.

  • A4: 0
  • A3: 1
  • A5: 2
  • Custom: 3
  • PrinterDefault: 4
Width Int32 The paper width in millimeters to use if the paper size is "custom".
Height Int32 The paper height in millimeters to use if the paper size is "custom".
ColorMode Int32 The color mode to apply to the server printer.

  • BlackAndWhite: 0
  • FullColor: 1
FilePathId Int64? The business key identifier of the file path used as output path of a Microsoft Print To PDF Printer

References FilePaths.

 Introduced in version 26.4
FilePath FilePaths The file path used as output path of a Microsoft Print To PDF Printer

References FilePaths.

  • Expandable
 Introduced in version 26.4
SubPath String The sub path applied to used as output path of a Microsoft Print To PDF Printer

  • Max length is 300
 Introduced in version 26.4

Example

{
  "Id": 0,
  "Number": null,
  "Description": null,
  "Name": null,
  "Orientation": 0,
  "DuplexMode": 0,
  "PaperSize": 0,
  "Width": 0,
  "Height": 0,
  "ColorMode": 0,
  "FilePathId": null,
  "FilePath": null,
  "SubPath": null
}