Printing

Get

Retrieve information about RAS printing settings.

GET/api/PrintingSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

embedFontsboolean

Whether Embed Fonts is enabled or not.

replicatePrinterFontboolean

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

replicatePrinterPatternboolean

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

replicatePrinterDriversboolean

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

driverAllowModePrnDriverAllowMode (enum)

Printer Driver Allow Mode.

0 = AllowRedirUsingAnyDriver,1 = AllowRedirUsingSpecifiedDriver,2 = DoNotAllowRedirUsingSpecifiedDriver

printerDriversArraynullable array of string

Printer Drivers string array.

excludedFontsArraynullable array of string

Excluded Fonts string array.

autoInstallFontsnullable array of string

Auto Installed Fonts.

printerNamePatternnullable string

Printer Name Pattern.

Request

JavaScriptCurlPython

const response = await fetch('/api/PrintingSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

Update

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.

PUT/api/PrintingSettings

Query parameters

Body

application/json; api-version=1.0

RAS Printing settings

printerDriversArraynullable array of string

Printer Drivers string array.

excludedFontsArraynullable array of string

Excluded Fonts string array.

printerNamePatternnullable string

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

embedFontsnullable boolean

Embed Fonts.

replicatePrinterFontnullable boolean

Replicate Printer Font Settings.

replicatePrinterPatternnullable boolean

Replicate Printer Name Pattern Settings.

replicatePrinterDriversnullable boolean

Replicate Printer Drivers Settings.

driverAllowModePrnDriverAllowMode (enum)

Printer Driver Allow Mode.

0 = AllowRedirUsingAnyDriver,1 = AllowRedirUsingSpecifiedDriver,2 = DoNotAllowRedirUsingSpecifiedDriver

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/PrintingSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}