Publised resources Default Settings

Get

get

Retrieve default settings used to configure published resources for a specific Site

Query parameters

siteIdinteger · int32Optional

Site ID from which to retrieve the defaults

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubDefaultSettings

HTTPcURLJavaScriptPython

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

{
  "siteId": 1,
  "startPath": "text",
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "createShortcutInStartUpFolder": true,
  "replicateShortcutSettings": true,
  "replicateDisplaySettings": true,
  "waitForPrinters": true,
  "startMaximized": true,
  "startFullscreen": true,
  "waitForPrintersTimeout": 1,
  "colorDepth": [
    "0 = Colors8Bit",
    "1 = Colors15Bit",
    "2 = Colors16Bit",
    "3 = Colors24Bit",
    "4 = Colors32Bit",
    "5 = ClientSpecified"
  ],
  "disableSessionSharing": true,
  "oneInstancePerUser": true,
  "conCurrentLicenses": 1,
  "licenseLimitNotify": [
    "0 = WarnUserAndNoStart",
    "1 = WarnUserAndStart",
    "2 = NotifyAdminAndStart",
    "3 = NotifyUserAdminAndStart",
    "4 = NotifyUserAdminAndNoStart"
  ],
  "replicateLicenseSettings": true,
  "replicateMaintenance": true,
  "maintenanceMessages": {
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "maintenanceMessage_de_DE": "text"
  }
}

Update

put

Modify default settings used to configure published resources for a specific Site

Query parameters

siteIdinteger · int32Optional

Site ID from which to update the defaults

Body

application/json; api-version=1.0

Update default settings of published resources

createShortcutOnDesktopboolean · nullableOptional

Enable or disable the 'Create shortcut on Desktop' option.

replicateShortcutSettingsboolean · nullableOptional

Enable or disable the 'Replicate settings' option.

createShortcutInStartFolderboolean · nullableOptional

Enable or disable the 'Create shortcut in Start folder' option.

createShortcutInStartUpFolderboolean · nullableOptional

Enable or disable the 'Create shortcut in Auto Start folder' option.

startPathstring · min: 1 · max: 255 · nullableOptional

Specifies a path in the Start folder.

replicateDisplaySettingsboolean · nullableOptional

Enable or disable the "Replicate settings option'. This will replicate display settings to all sites.

startMaximizedboolean · nullableOptional

Enable or disable the 'Start the application as maximized when using mobile clients" option.

startFullscreenboolean · nullableOptional

Enable or disable the 'Start in fullscreen mode for WYSE ThinOS clients" option.

waitForPrintersboolean · nullableOptional

Enable or disable the 'Wait until all RAS Universal Printers are redirected before showing the application" option.

waitForPrintersTimeoutinteger · int32 · nullableOptional

Printer redirection timeout (in seconds). Works together with the WaitForPrinters parameter.

colorDepthstring · enumOptional

Color Depth

Possible values:

replicateLicenseSettingsboolean · nullableOptional

Enable or disable the 'Replicate settings' option. This will replicate license settings to all sites.

disableSessionSharingboolean · nullableOptional

Enable or disable the 'Disable session sharing' option.

oneInstancePerUserboolean · nullableOptional

Enable or disable the 'Allow users to start only one instance of the application' option.

conCurrentLicensesinteger · int32 · nullableOptional

Specifies the number of concurrent licenses (the 'Concurrent licenses' option).

licenseLimitNotifystring · enumOptional

Defines actions to perform when the license limit is exceeded.

Possible values:

maintenanceMessage_en_USstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in French.

maintenanceMessage_es_ESstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Chinese (Traditional).

maintenanceMessage_zh_CNstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Chinese (Simplified).

maintenanceMessage_ko_KRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Korean.

replicateMaintenanceboolean · nullableOptional

Enable or disable the 'Replicate Maintenance' option.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/PubDefaultSettings

HTTPcURLJavaScriptPython

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

{
  "createShortcutOnDesktop": true,
  "replicateShortcutSettings": true,
  "createShortcutInStartFolder": true,
  "createShortcutInStartUpFolder": true,
  "startPath": "text",
  "replicateDisplaySettings": true,
  "startMaximized": true,
  "startFullscreen": true,
  "waitForPrinters": true,
  "waitForPrintersTimeout": 1,
  "colorDepth": [
    "0 = Colors8Bit",
    "1 = Colors15Bit",
    "2 = Colors16Bit",
    "3 = Colors24Bit",
    "4 = Colors32Bit",
    "5 = ClientSpecified"
  ],
  "replicateLicenseSettings": true,
  "disableSessionSharing": true,
  "oneInstancePerUser": true,
  "conCurrentLicenses": 1,
  "licenseLimitNotify": [
    "0 = WarnUserAndNoStart",
    "1 = WarnUserAndStart",
    "2 = NotifyAdminAndStart",
    "3 = NotifyUserAdminAndStart",
    "4 = NotifyUserAdminAndNoStart"
  ],
  "maintenanceMessage_en_US": "text",
  "maintenanceMessage_ja_JP": "text",
  "maintenanceMessage_fr_FR": "text",
  "maintenanceMessage_es_ES": "text",
  "maintenanceMessage_it_IT": "text",
  "maintenanceMessage_pt_BR": "text",
  "maintenanceMessage_de_DE": "text",
  "maintenanceMessage_nl_NL": "text",
  "maintenanceMessage_zh_TW": "text",
  "maintenanceMessage_zh_CN": "text",
  "maintenanceMessage_ko_KR": "text",
  "replicateMaintenance": true
}

No content