Scanning

Get

Retrieve information about RAS scanning settings.

GET/api/ScanningSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

twainNamePatternnullable string

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

replicateTWAINPatternboolean

Whether to Replicate TWAIN Pattern or not.

wiaNamePatternnullable string

WIA Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID%

replicateWIAPatternboolean

Whether to Replicate WIA Pattern or not.

twainAppsnullable array of string

Specifies items in the TWAIN Applications list.

replicateTWAINAppsboolean

Whether to replicate TWAIN Applications or not.

Request

JavaScriptCurlPython

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

Response

200401404

{
  "twainNamePattern": "text",
  "replicateTWAINPattern": false,
  "wiaNamePattern": "text",
  "replicateWIAPattern": false,
  "twainApps": [
    "text"
  ],
  "replicateTWAINApps": false
}

Update

Update scanning 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/ScanningSettings

Query parameters

Body

application/json; api-version=1.0

RAS Scanning settings

wiaNamePatternnullable string

WIA Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID%

replicateWIAPatternnullable boolean

Replicate WIA pattern.

twainNamePatternnullable string

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

replicateTWAINPatternnullable boolean

Replicate TWAIN Pattern.

twainAppsnullable array of string

Specifies items in the TWAIN Applications list.

replicateTWAINAppsnullable boolean

Replicate TWAIN Applications.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/ScanningSettings', {
    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"
}