For the complete documentation index, see llms.txt. This page is also available as Markdown.

Scanning

Get

get

Retrieve information about RAS scanning settings.

Query parameters
SiteIdinteger · int32Optional

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

Responses
401

Unauthorized

application/json; api-version=1.0
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
get/api/ScanningSettings
GET /api/ScanningSettings HTTP/1.1
Accept: */*
{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Update

put

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.

Query parameters
SiteIdinteger · int32Optional

Site ID (optional)

Body

Update RAS Universal Scanning settings

wiaNamePatternstring · max: 255 · nullableOptional

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

replicateWIAPatternboolean · nullableOptional

Replicate WIA pattern.

twainNamePatternstring · max: 255 · nullableOptional

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

replicateTWAINPatternboolean · nullableOptional

Replicate TWAIN Pattern.

twainAppsstring[] · nullableOptional

Specifies items in the TWAIN Applications list.

replicateTWAINAppsboolean · nullableOptional

Replicate TWAIN Applications.

Responses
401

Unauthorized

application/json; api-version=1.0
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
put/api/ScanningSettings
PUT /api/ScanningSettings HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 154

{
  "wiaNamePattern": "text",
  "replicateWIAPattern": true,
  "twainNamePattern": "text",
  "replicateTWAINPattern": true,
  "twainApps": [
    "text"
  ],
  "replicateTWAINApps": true
}
{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}