Printing

Get

get

Retrieve information about RAS printing settings.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve the RAS universal printing settings (optional)

Responses

200

Success

application/json; api-version=1.0

RAS Printing Settings

embedFontsbooleanOptional

Whether Embed Fonts is enabled or not.

replicatePrinterFontbooleanOptional

Whether the option "Replicate Printer Font Settings" is enabled or not..

replicatePrinterPatternbooleanOptional

Whether the option "Replicate Printer Name Pattern Settings" is enabled or not.

replicatePrinterDriversbooleanOptional

Whether the option "Replicate Printer Drivers Settings" is enabled or not.

driverAllowModestring · enumOptional

Printer Driver Allow Mode.

Possible values:

printerDriversArraystring[] · nullableOptional

Printer Drivers string array.

excludedFontsArraystring[] · nullableOptional

Excluded Fonts string array.

autoInstallFontsstring[] · nullableOptional

Auto Installed Fonts.

printerNamePatternstring · nullableOptional

Printer Name Pattern.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PrintingSettings

HTTPcURLJavaScriptPython

GET /api/PrintingSettings HTTP/1.1
Accept: */*

{
  "embedFonts": true,
  "replicatePrinterFont": true,
  "replicatePrinterPattern": true,
  "replicatePrinterDrivers": true,
  "driverAllowMode": [
    "0 = AllowRedirUsingAnyDriver",
    "1 = AllowRedirUsingSpecifiedDriver",
    "2 = DoNotAllowRedirUsingSpecifiedDriver"
  ],
  "printerDriversArray": [
    "text"
  ],
  "excludedFontsArray": [
    "text"
  ],
  "autoInstallFonts": [
    "text"
  ],
  "printerNamePattern": "text"
}

Update

put

Modify printing settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Query parameters

SiteIdinteger · int32Optional

Site ID (optional)

Body

application/json; api-version=1.0

Update RAS Universal Printing settings

printerDriversArraystring[] · nullableOptional

Printer Drivers string array.

excludedFontsArraystring[] · nullableOptional

Excluded Fonts string array.

printerNamePatternstring · max: 255 · nullableOptional

Printer Name Pattern. Default pattern: %PRINTERNAME% for %USERNAME% by Parallels Valid pattern variables: %PRINTERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% Other valid pattern: 2X Universal Printer

embedFontsboolean · nullableOptional

Embed Fonts.

replicatePrinterFontboolean · nullableOptional

Replicate Printer Font Settings.

replicatePrinterPatternboolean · nullableOptional

Replicate Printer Name Pattern Settings.

replicatePrinterDriversboolean · nullableOptional

Replicate Printer Drivers Settings.

driverAllowModestring · enumOptional

Printer Driver Allow Mode.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/PrintingSettings

HTTPcURLJavaScriptPython

PUT /api/PrintingSettings HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 328

{
  "printerDriversArray": [
    "text"
  ],
  "excludedFontsArray": [
    "text"
  ],
  "printerNamePattern": "text",
  "embedFonts": true,
  "replicatePrinterFont": true,
  "replicatePrinterPattern": true,
  "replicatePrinterDrivers": true,
  "driverAllowMode": [
    "0 = AllowRedirUsingAnyDriver",
    "1 = AllowRedirUsingSpecifiedDriver",
    "2 = DoNotAllowRedirUsingSpecifiedDriver"
  ]
}

No content