Local

Create

Add a published Local application to a site.

POST/api/PubItems/Apps/Local

Body

name*nullable string

Published resource name.

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of Sites IDs to which to publish a resource.

itemsinteger (int32)

siteIdinteger (int32)

Site ID in which to publish the specified Item. If the parameter is omitted, the site ID of the Licensing Server will be used.

urlnullable string

URL.

windowsEnablednullable boolean

Windows: Whether the application is enabled for the operating system or not.

windowsUseIfAvailablenullable boolean

Windows: Use the following application if available on local device.

windowsStartInnullable string

Windows: Application working directory.

windowsTargetnullable string

Windows: Application target file. (i.e. calc.exe, file.txt, etc.).

windowsParametersnullable string

Windows: Application parameters.

windowsWinTypeWindowType (enum)

Published application window type

0 = Normal,1 = Maximized,2 = Minimized

macEnablednullable boolean

Mac: Whether the application is enabled for the operating system or not.

linuxEnablednullable boolean

Linux: Whether the application is enabled for the operating system or not.

iOSEnablednullable boolean

iOS: Whether the application is enabled for the operating system or not.

androidEnablednullable boolean

Android: Whether the application is enabled for the operating system or not.

userPortalEnablednullable boolean

UserPortal: Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsnullable boolean

Whether to replicate local application settings or not.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop,10 = LocalApp

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

List of the IDs of all the sites this item is published to.

itemsinteger (int32)

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

Whether the 'Start automatically when user logs on' option is enabled or disabled.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

Whether to create a shortcut in the start folder or not.

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

urlnullable string

URL.

windowsWindows (object)

Publishing Local Application - Windows.

enabledboolean

Whether the application is enabled for the operating system or not.

useIfAvailableboolean

Use the following application if available on local device.

targetnullable string

Application target file. (i.e. calc.exe, file.txt, etc.).

startInnullable string

Application working directory.

parametersnullable string

Application parameters.

winTypeWindowType (enum)

Published application window type

0 = Normal,1 = Maximized,2 = Minimized

macMac (object)

Publishing Local Application - Mac.

enabledboolean

Whether the application is enabled for the operating system or not.

linuxLinux (object)

Publishing Local Application - Linux.

enabledboolean

Whether the application is enabled for the operating system or not.

iOSiOS (object)

Publishing Local Application - iOS.

enabledboolean

Whether the application is enabled for the operating system or not.

androidAndroid (object)

Publishing Local Application - Android.

enabledboolean

Whether the application is enabled for the operating system or not.

userPortalUserPortal (object)

Publishing Local Application - Web Client.

enabledboolean

Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsboolean

Whether to replicate local application settings or not.

Request

Response

List

Retrieve a list of all the published Local applications

GET/api/PubItems/Apps/Local

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve all the published Local applications (optional)

Response

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop,10 = LocalApp

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

List of the IDs of all the sites this item is published to.

itemsinteger (int32)

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

Whether the 'Start automatically when user logs on' option is enabled or disabled.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

Whether to create a shortcut in the start folder or not.

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

urlnullable string

URL.

windowsWindows (object)

Publishing Local Application - Windows.

enabledboolean

Whether the application is enabled for the operating system or not.

useIfAvailableboolean

Use the following application if available on local device.

targetnullable string

Application target file. (i.e. calc.exe, file.txt, etc.).

startInnullable string

Application working directory.

parametersnullable string

Application parameters.

winTypeWindowType (enum)

Published application window type

0 = Normal,1 = Maximized,2 = Minimized

macMac (object)

Publishing Local Application - Mac.

enabledboolean

Whether the application is enabled for the operating system or not.

linuxLinux (object)

Publishing Local Application - Linux.

enabledboolean

Whether the application is enabled for the operating system or not.

iOSiOS (object)

Publishing Local Application - iOS.

enabledboolean

Whether the application is enabled for the operating system or not.

androidAndroid (object)

Publishing Local Application - Android.

enabledboolean

Whether the application is enabled for the operating system or not.

userPortalUserPortal (object)

Publishing Local Application - Web Client.

enabledboolean

Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsboolean

Whether to replicate local application settings or not.

Request

Response

Update

Modify properties of a published Local application.

PUT/api/PubItems/{id}/Apps/Local

Path parameters

id*integer (int32)

ID of the published Local application to be updated

Body

Published Local application configuration

namenullable string

A new name to assign to the published resource.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

itemsinteger (int32)

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

Create a shortcut in the client's Auto Start folder.

startPathnullable string

Specifies the path in the Start folder where the shortcut will be created.

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

urlnullable string

URL.

windowsEnablednullable boolean

Windows: Whether the application is enabled for the operating system or not.

windowsUseIfAvailablenullable boolean

Windows: Use the following application if available on local device.

windowsStartInnullable string

Windows: Application working directory.

windowsTargetnullable string

Windows: Application target file. (i.e. calc.exe, file.txt, etc.).

windowsParametersnullable string

Windows: Application parameters.

windowsWinTypeWindowType (enum)

Published application window type

0 = Normal,1 = Maximized,2 = Minimized

macEnablednullable boolean

Mac: Whether the application is enabled for the operating system or not.

linuxEnablednullable boolean

Linux: Whether the application is enabled for the operating system or not.

iOSEnablednullable boolean

iOS: Whether the application is enabled for the operating system or not.

androidEnablednullable boolean

Android: Whether the application is enabled for the operating system or not.

userPortalEnablednullable boolean

UserPortal: Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsnullable boolean

Whether to replicate local application settings or not.

Response

No Content

Request

Response

Delete

Delete a published application from a site.

DELETE/api/PubItems/{id}/Apps/Local

Path parameters

id*integer (int32)

ID of the published Local application to be deleted

Response

No Content

Request

Response

Delete

Delete a published application from a site.

DELETE/api/PubItems/{id}/Apps/Local

Path parameters

id*integer (int32)

ID of the published Local application to be deleted

Response

No Content

Request

Response

Update

Modify properties of a published Local application.

PUT/api/PubItems/{id}/Apps/Local

Path parameters

id*integer (int32)

ID of the published Local application to be updated

Body

Published Local application configuration

namenullable string

A new name to assign to the published resource.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

itemsinteger (int32)

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

Create a shortcut in the client's Auto Start folder.

startPathnullable string

Specifies the path in the Start folder where the shortcut will be created.

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

urlnullable string

URL.

windowsEnablednullable boolean

Windows: Whether the application is enabled for the operating system or not.

windowsUseIfAvailablenullable boolean

Windows: Use the following application if available on local device.

windowsStartInnullable string

Windows: Application working directory.

windowsTargetnullable string

Windows: Application target file. (i.e. calc.exe, file.txt, etc.).

windowsParametersnullable string

Windows: Application parameters.

windowsWinTypeWindowType (enum)

Published application window type

0 = Normal,1 = Maximized,2 = Minimized

macEnablednullable boolean

Mac: Whether the application is enabled for the operating system or not.

linuxEnablednullable boolean

Linux: Whether the application is enabled for the operating system or not.

iOSEnablednullable boolean

iOS: Whether the application is enabled for the operating system or not.

androidEnablednullable boolean

Android: Whether the application is enabled for the operating system or not.

userPortalEnablednullable boolean

UserPortal: Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsnullable boolean

Whether to replicate local application settings or not.

Response

No Content

Request

Response

Create

Add a published Local application to a site.

POST/api/PubItems/Apps/Local

Body

name*nullable string

Published resource name.

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of Sites IDs to which to publish a resource.

itemsinteger (int32)

siteIdinteger (int32)

Site ID in which to publish the specified Item. If the parameter is omitted, the site ID of the Licensing Server will be used.

urlnullable string

URL.

windowsEnablednullable boolean

Windows: Whether the application is enabled for the operating system or not.

windowsUseIfAvailablenullable boolean

Windows: Use the following application if available on local device.

windowsStartInnullable string

Windows: Application working directory.

windowsTargetnullable string

Windows: Application target file. (i.e. calc.exe, file.txt, etc.).

windowsParametersnullable string

Windows: Application parameters.

windowsWinTypeWindowType (enum)

Published application window type

0 = Normal,1 = Maximized,2 = Minimized

macEnablednullable boolean

Mac: Whether the application is enabled for the operating system or not.

linuxEnablednullable boolean

Linux: Whether the application is enabled for the operating system or not.

iOSEnablednullable boolean

iOS: Whether the application is enabled for the operating system or not.

androidEnablednullable boolean

Android: Whether the application is enabled for the operating system or not.

userPortalEnablednullable boolean

UserPortal: Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsnullable boolean

Whether to replicate local application settings or not.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop,10 = LocalApp

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

List of the IDs of all the sites this item is published to.

itemsinteger (int32)

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

Whether the 'Start automatically when user logs on' option is enabled or disabled.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

Whether to create a shortcut in the start folder or not.

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

urlnullable string

URL.

windowsWindows (object)

Publishing Local Application - Windows.

enabledboolean

Whether the application is enabled for the operating system or not.

useIfAvailableboolean

Use the following application if available on local device.

targetnullable string

Application target file. (i.e. calc.exe, file.txt, etc.).

startInnullable string

Application working directory.

parametersnullable string

Application parameters.

winTypeWindowType (enum)

Published application window type

0 = Normal,1 = Maximized,2 = Minimized

macMac (object)

Publishing Local Application - Mac.

enabledboolean

Whether the application is enabled for the operating system or not.

linuxLinux (object)

Publishing Local Application - Linux.

enabledboolean

Whether the application is enabled for the operating system or not.

iOSiOS (object)

Publishing Local Application - iOS.

enabledboolean

Whether the application is enabled for the operating system or not.

androidAndroid (object)

Publishing Local Application - Android.

enabledboolean

Whether the application is enabled for the operating system or not.

userPortalUserPortal (object)

Publishing Local Application - Web Client.

enabledboolean

Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsboolean

Whether to replicate local application settings or not.

Request

Response

List

Retrieve a list of all the published Local applications

GET/api/PubItems/Apps/Local

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve all the published Local applications (optional)

Response

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop,10 = LocalApp

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

List of the IDs of all the sites this item is published to.

itemsinteger (int32)

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

Whether the 'Start automatically when user logs on' option is enabled or disabled.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

Whether to create a shortcut in the start folder or not.

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

urlnullable string

URL.

windowsWindows (object)

Publishing Local Application - Windows.

enabledboolean

Whether the application is enabled for the operating system or not.

useIfAvailableboolean

Use the following application if available on local device.

targetnullable string

Application target file. (i.e. calc.exe, file.txt, etc.).

startInnullable string

Application working directory.

parametersnullable string

Application parameters.

winTypeWindowType (enum)

Published application window type

0 = Normal,1 = Maximized,2 = Minimized

macMac (object)

Publishing Local Application - Mac.

enabledboolean

Whether the application is enabled for the operating system or not.

linuxLinux (object)

Publishing Local Application - Linux.

enabledboolean

Whether the application is enabled for the operating system or not.

iOSiOS (object)

Publishing Local Application - iOS.

enabledboolean

Whether the application is enabled for the operating system or not.

androidAndroid (object)

Publishing Local Application - Android.

enabledboolean

Whether the application is enabled for the operating system or not.

userPortalUserPortal (object)

Publishing Local Application - Web Client.

enabledboolean

Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsboolean

Whether to replicate local application settings or not.

Request

Response

const response = await fetch('/api/PubItems/{id}/Apps/Local', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

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

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

const response = await fetch('/api/PubItems/Apps/Local', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:19:38.225Z",
  "timeLastMod": "2024-11-07T10:19:38.225Z",
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop",
    "10 = LocalApp"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "url": "text",
  "windows": {
    "enabled": false,
    "useIfAvailable": false,
    "target": "text",
    "startIn": "text",
    "parameters": "text",
    "winType": [
      "0 = Normal",
      "1 = Maximized",
      "2 = Minimized"
    ]
  },
  "mac": {
    "enabled": false
  },
  "linux": {
    "enabled": false
  },
  "iOS": {
    "enabled": false
  },
  "android": {
    "enabled": false
  },
  "userPortal": {
    "enabled": false
  },
  "replicateLocalAppSettings": false
}

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

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:19:38.225Z",
    "timeLastMod": "2024-11-07T10:19:38.225Z",
    "name": "text",
    "type": [
      "0 = Any",
      "1 = Folder",
      "2 = RDSApp",
      "3 = RDSDesktop",
      "4 = VDIDesktop",
      "5 = PCDesktop",
      "6 = PCApp",
      "7 = VDIApp",
      "8 = AVDApp",
      "9 = AVDDesktop",
      "10 = LocalApp"
    ],
    "description": "text",
    "enabledMode": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = Maintenance"
    ],
    "enabled": false,
    "publishToSite": [],
    "filter": {
      "rules": [
        {
          "enabled": false,
          "name": "text",
          "description": "text",
          "criteria": {
            "securityPrincipals": {
              "enabled": false,
              "matchingMode": [
                "0 = IsNotOneOfTheFollowing",
                "1 = IsOneOfTheFollowing"
              ],
              "members": [
                {
                  "account": "text",
                  "type": [
                    "1 = User",
                    "2 = Group",
                    "3 = ForeignSecurityPrincipal",
                    "4 = Computer"
                  ],
                  "sid": "text"
                }
              ]
            },
            "gateways": {
              "enabled": false,
              "matchingMode": [
                "0 = IsNotOneOfTheFollowing",
                "1 = IsOneOfTheFollowing"
              ],
              "members": [
                {
                  "gatewayIP": "text"
                }
              ]
            },
            "oSs": {
              "enabled": false,
              "matchingMode": [
                "0 = IsNotOneOfTheFollowing",
                "1 = IsOneOfTheFollowing"
              ],
              "allowedOSes": {
                "chrome": false,
                "android": false,
                "webClient": false,
                "iOS": false,
                "linux": false,
                "mac": false,
                "wyse": false,
                "windows": false
              }
            },
            "iPs": {
              "enabled": false,
              "matchingMode": [
                "0 = IsNotOneOfTheFollowing",
                "1 = IsOneOfTheFollowing"
              ],
              "allowedIPs": {
                "iPv4s": [
                  {
                    "from": "text",
                    "to": "text"
                  }
                ],
                "iPv6s": [
                  {
                    "from": "text",
                    "to": "text"
                  }
                ]
              }
            },
            "hardwareIDs": {
              "enabled": false,
              "matchingMode": [
                "0 = IsNotOneOfTheFollowing",
                "1 = IsOneOfTheFollowing"
              ],
              "members": [
                {
                  "hardwareID": "text"
                }
              ]
            },
            "access": [
              "0 = DenyCriteriaWhen",
              "1 = AllowCriteriaWhen"
            ],
            "devices": {
              "enabled": false,
              "matchingMode": [
                "0 = IsNotOneOfTheFollowing",
                "1 = IsOneOfTheFollowing"
              ],
              "members": [
                {
                  "client": "text"
                }
              ]
            },
            "themes": {
              "enabled": false,
              "matchingMode": [
                "0 = IsNotOneOfTheFollowing",
                "1 = IsOneOfTheFollowing"
              ],
              "ids": []
            }
          }
        }
      ],
      "default": [
        "0 = Deny",
        "1 = Allow"
      ]
    },
    "startOnLogon": false,
    "inheritShortcutDefaultSettings": false,
    "createShortcutOnDesktop": false,
    "createShortcutInStartFolder": false,
    "startPath": "text",
    "createShortcutInStartUpFolder": false,
    "replicateShortcutSettings": false,
    "url": "text",
    "windows": {
      "enabled": false,
      "useIfAvailable": false,
      "target": "text",
      "startIn": "text",
      "parameters": "text",
      "winType": [
        "0 = Normal",
        "1 = Maximized",
        "2 = Minimized"
      ]
    },
    "mac": {
      "enabled": false
    },
    "linux": {
      "enabled": false
    },
    "iOS": {
      "enabled": false
    },
    "android": {
      "enabled": false
    },
    "userPortal": {
      "enabled": false
    },
    "replicateLocalAppSettings": false
  }
]