Publised resources Default Settings

PreviousVDI NextPolicies

Last updated 10 months ago

Was this helpful?

Get

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

GET/api/PubDefaultSettings

Query parameters

Response

Success

Body

siteIdinteger (int32)

ID of the Site.

startPathnullable string

Starting path of the settings.

createShortcutOnDesktopboolean

Whether the 'Create shortcut on Desktop' option is enabled or not.

createShortcutInStartFolderboolean

Whether the 'Create shortcut in Start Folder' option is enabled or not.

createShortcutInStartUpFolderboolean

Whether the 'Create shortcut in Auto Start Folder' option is enabled or not.

replicateShortcutSettingsboolean

Whether the 'Replicate Shortcut Settings' option is enabled or not.

replicateDisplaySettingsboolean

Whether the 'Replicate Display Settings' option is enabled or not.

waitForPrintersboolean

Whether the option 'Wait until all RAS Universal Printers are redirected before showing the application' is enabled or not.

startMaximizedboolean

Whether the option 'Start Maximized' is enabled or not.

startFullscreenboolean

Whether the option 'StartFullscreen' is enabled or not.

waitForPrintersTimeoutinteger (int32)

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

colorDepthenum

Color Depth

0 = Colors8Bit,1 = Colors15Bit,2 = Colors16Bit,3 = Colors24Bit,4 = Colors32Bit,5 = ClientSpecified

disableSessionSharingboolean

Whether the option 'Disable Session Sharing' is enabled or not.

oneInstancePerUserboolean

Whether the option 'Allow users to start only one instance of the application' is enabled or not.

conCurrentLicensesinteger (int32)

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

licenseLimitNotifyenum

Defines actions to perform when the license limit is exceeded.

0 = WarnUserAndNoStart,1 = WarnUserAndStart,2 = NotifyAdminAndStart,3 = NotifyUserAdminAndStart,4 = NotifyUserAdminAndNoStart

replicateLicenseSettingsboolean

Whether the option 'Replicate license settings' is enabled or not.

replicateMaintenanceboolean

Whether the option 'Replicate Maintenance' is enabled or not.

maintenanceMessagesobject

Contains a set of maintenance messages in various languages

Request

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

Response

{
  "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

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

PUT/api/PubDefaultSettings

Query parameters

Body

Publishing defaults configuration

createShortcutOnDesktopnullable boolean

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

replicateShortcutSettingsnullable boolean

Enable or disable the 'Replicate settings' option.

createShortcutInStartFoldernullable boolean

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

createShortcutInStartUpFoldernullable boolean

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

startPathnullable string

Specifies a path in the Start folder.

replicateDisplaySettingsnullable boolean

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

startMaximizednullable boolean

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

startFullscreennullable boolean

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

waitForPrintersnullable boolean

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

waitForPrintersTimeoutnullable integer (int32)

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

colorDepthenum

Color Depth

0 = Colors8Bit,1 = Colors15Bit,2 = Colors16Bit,3 = Colors24Bit,4 = Colors32Bit,5 = ClientSpecified

replicateLicenseSettingsnullable boolean

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

disableSessionSharingnullable boolean

Enable or disable the 'Disable session sharing' option.

oneInstancePerUsernullable boolean

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

conCurrentLicensesnullable integer (int32)

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

licenseLimitNotifyenum

Defines actions to perform when the license limit is exceeded.

0 = WarnUserAndNoStart,1 = WarnUserAndStart,2 = NotifyAdminAndStart,3 = NotifyUserAdminAndStart,4 = NotifyUserAdminAndNoStart

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

replicateMaintenancenullable boolean

Enable or disable the 'Replicate Maintenance' option.

Response

No Content

Request

const response = await fetch('/api/PubDefaultSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "colorDepth": [
        "0 = Colors8Bit",
        "1 = Colors15Bit",
        "2 = Colors16Bit",
        "3 = Colors24Bit",
        "4 = Colors32Bit",
        "5 = ClientSpecified"
      ],
      "licenseLimitNotify": [
        "0 = WarnUserAndNoStart",
        "1 = WarnUserAndStart",
        "2 = NotifyAdminAndStart",
        "3 = NotifyUserAdminAndStart",
        "4 = NotifyUserAdminAndNoStart"
      ]
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}