# Local

## Create

> Add a published Local application to a site.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/Apps/Local":{"post":{"tags":["3-Publishing/Applications//Local"],"summary":"Create","description":"Add a published Local application to a site.","operationId":"756585a5-2b22-4a9f-8c4a-a0f179602adc","requestBody":{"content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/NewPubLocalApp"}}}},"responses":{"201":{"description":"Created","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/PubLocalApp"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"NewPubLocalApp":{"required":["name"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Published resource name.</para>","nullable":true},"parentId":{"type":"integer","description":"<para type=\"description\">Parent publishing folder ID.</para>","format":"int32","nullable":true},"previousId":{"type":"integer","description":"<para type=\"description\">Previous published ID.</para>","format":"int32","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"description":{"type":"string","description":"<para type=\"description\">Published resource description.</para>","nullable":true},"publishToSiteIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">An array of Sites IDs to which to publish a resource.</para>","nullable":true},"siteId":{"type":"integer","description":"<para type=\"description\">Site ID in which to publish the specified Item.</para>\r\n<para type=\"description\">If the parameter is omitted, the site ID of the Licensing Server will be used.</para>","format":"int32"},"url":{"type":"string","description":"<para type=\"description\">URL.</para>","nullable":true},"windowsEnabled":{"type":"boolean","description":"<para type=\"description\">Windows: Whether the application is enabled for the operating system or not.</para>","nullable":true},"windowsUseIfAvailable":{"type":"boolean","description":"<para type=\"description\">Windows: Use the following application if available on local device.</para>","nullable":true},"windowsStartIn":{"maxLength":260,"minLength":0,"type":"string","description":"<para type=\"description\">Windows: Application working directory.</para>","nullable":true},"windowsTarget":{"maxLength":260,"minLength":0,"type":"string","description":"<para type=\"description\">Windows: Application target file. (i.e. calc.exe, file.txt, etc.).</para>","nullable":true},"windowsParameters":{"maxLength":1024,"minLength":0,"type":"string","description":"<para type=\"description\">Windows: Application parameters.</para>","nullable":true},"windowsWinType":{"$ref":"#/components/schemas/WindowType"},"macEnabled":{"type":"boolean","description":"<para type=\"description\">Mac: Whether the application is enabled for the operating system or not.</para>","nullable":true},"linuxEnabled":{"type":"boolean","description":"<para type=\"description\">Linux: Whether the application is enabled for the operating system or not.</para>","nullable":true},"iOSEnabled":{"type":"boolean","description":"<para type=\"description\">iOS: Whether the application is enabled for the operating system or not.</para>","nullable":true},"androidEnabled":{"type":"boolean","description":"<para type=\"description\">Android: Whether the application is enabled for the operating system or not.</para>","nullable":true},"userPortalEnabled":{"type":"boolean","description":"<para type=\"description\">UserPortal: Whether the application is enabled for the operating system or not.</para>","nullable":true},"replicateLocalAppSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate local application settings or not.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Create a new published local application </para>\r\n<para type=\"description\"></para>"},"PubResourceEnabledMode":{"enum":[["0 = Disabled","1 = Enabled","2 = Maintenance"]],"type":"string","description":"<para type=\"synopsis\">Published resource availability modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowType":{"enum":[["0 = Normal","1 = Maximized","2 = Minimized"]],"type":"string","description":"<para type=\"synopsis\">Published application window type</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"PubLocalApp":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"name":{"type":"string","description":"<para type=\"description\">Name of the published item.</para>","nullable":true},"type":{"$ref":"#/components/schemas/RASPubObject"},"parentId":{"type":"integer","description":"<para type=\"description\">ID of the parent folder of the published item.</para>","format":"int32"},"previousId":{"type":"integer","description":"<para type=\"description\">ID of the previous published item.</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Description of the published item.</para>","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the published item is enabled or not.</para>"},"publishToSite":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">List of the IDs of all the sites this item is published to.</para>","nullable":true},"filter":{"$ref":"#/components/schemas/PubItemFilter"},"startOnLogon":{"type":"boolean","description":"<para type=\"description\">Whether the 'Start automatically when user logs on' option is enabled or disabled.</para>"},"inheritShortcutDefaultSettings":{"type":"boolean","description":"<para type=\"description\">Whether to inherit default shortcut settings or not.</para>"},"createShortcutOnDesktop":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut on the desktop or not.</para>"},"createShortcutInStartFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the start folder or not.</para>"},"startPath":{"type":"string","description":"<para type=\"description\">Starting path of the published item.</para>","nullable":true},"createShortcutInStartUpFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the startup folder or not.</para>"},"replicateShortcutSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate shortcut settings or not.</para>"},"url":{"type":"string","description":"<para type=\"description\">URL.</para>","nullable":true},"windows":{"$ref":"#/components/schemas/Windows"},"mac":{"$ref":"#/components/schemas/Mac"},"linux":{"$ref":"#/components/schemas/Linux"},"iOS":{"$ref":"#/components/schemas/iOS"},"android":{"$ref":"#/components/schemas/Android"},"userPortal":{"$ref":"#/components/schemas/UserPortal"},"replicateLocalAppSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate local application settings or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Published Local Application</para>\r\n<para type=\"description\"></para>"},"RASPubObject":{"enum":[["0 = Any","1 = Folder","2 = RDSApp","3 = RDSDesktop","4 = VDIDesktop","5 = PCDesktop","6 = PCApp","7 = VDIApp","8 = AVDApp","9 = AVDDesktop","10 = LocalApp"]],"type":"string","description":"<para type=\"synopsis\">RAS Publishing Objects</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubItemFilter":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/PubItemRule"},"nullable":true},"default":{"$ref":"#/components/schemas/DefaultAssignmentType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">The PubItem Filter object.</para>\r\n<para type=\"description\"></para>"},"PubItemRule":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"priority":{"type":"integer","description":"<para type=\"description\">Priority of the object.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Rule is enabled or not</para>"},"name":{"type":"string","description":"<para type=\"description\">Name of the Rule</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Rule</para>","nullable":true},"criteria":{"$ref":"#/components/schemas/PubItemCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Rule</para>\r\n<para type=\"description\"></para>"},"PubItemCriteria":{"type":"object","properties":{"securityPrincipals":{"$ref":"#/components/schemas/SecurityPrincipalsCriteria"},"gateways":{"$ref":"#/components/schemas/GatewaysCriteria"},"oSs":{"$ref":"#/components/schemas/OSsCriteria"},"iPs":{"$ref":"#/components/schemas/IPsCriteria"},"hardwareIDs":{"$ref":"#/components/schemas/HardwareIDsCriteria"},"access":{"$ref":"#/components/schemas/AccessType"},"devices":{"$ref":"#/components/schemas/DevicesCriteria"},"themes":{"$ref":"#/components/schemas/ThemesCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Criteria</para>\r\n<para type=\"description\"></para>"},"SecurityPrincipalsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Security Principals Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/SecurityPrincipalCriteriaEntry"},"description":"<para type=\"description\">User criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principals Criteria</para>\r\n<para type=\"description\"></para>"},"MatchingModeType":{"enum":[["0 = IsNotOneOfTheFollowing","1 = IsOneOfTheFollowing"]],"type":"string","description":"<para type=\"synopsis\">Matching mode type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"SecurityPrincipalCriteriaEntry":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principal Criteria Entry</para>\r\n<para type=\"description\"></para>"},"UserType":{"enum":[["1 = User","2 = Group","3 = ForeignSecurityPrincipal","4 = Computer"]],"type":"string","description":"<para type=\"synopsis\">User Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"GatewaysCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Gateways Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/GatewayCriteriaEntry"},"description":"<para type=\"description\">Gateway criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateways Criteria</para>\r\n<para type=\"description\"></para>"},"GatewayCriteriaEntry":{"type":"object","properties":{"gatewayIP":{"type":"string","description":"<para type=\"description\">The gateway IP.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateway criteria entry</para>\r\n<para type=\"description\"></para>"},"OSsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the OSs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedOSes":{"$ref":"#/components/schemas/AllowedOperatingSystems"}},"additionalProperties":false,"description":"<para type=\"synopsis\">OS Criteria Settings</para>\r\n<para type=\"description\"></para>"},"AllowedOperatingSystems":{"type":"object","properties":{"chrome":{"type":"boolean","description":"<para type=\"description\">Whether Chrome is allowed or not.</para>"},"android":{"type":"boolean","description":"<para type=\"description\">Whether Android is allowed or not.</para>"},"webClient":{"type":"boolean","description":"<para type=\"description\">Whether Web Client is allowed or not.</para>"},"iOS":{"type":"boolean","description":"<para type=\"description\">Whether iOS is allowed or not.</para>"},"linux":{"type":"boolean","description":"<para type=\"description\">Whether Linux is allowed or not.</para>"},"mac":{"type":"boolean","description":"<para type=\"description\">Whether MAC OS is allowed or not.</para>"},"wyse":{"type":"boolean","description":"<para type=\"description\">Whether Wyse is allowed or not.</para>"},"windows":{"type":"boolean","description":"<para type=\"description\">Whether Windows is allowed or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed Operating Systems</para>\r\n<para type=\"description\"></para>"},"IPsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the IPs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedIPs":{"$ref":"#/components/schemas/AllowedIPsCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPs Criteria</para>\r\n<para type=\"description\"></para>"},"AllowedIPsCriteria":{"type":"object","properties":{"iPv4s":{"type":"array","items":{"$ref":"#/components/schemas/IPv4CriteriaEntry"},"description":"<para type=\"description\">IPv4 criteria list</para>","nullable":true},"iPv6s":{"type":"array","items":{"$ref":"#/components/schemas/IPv6CriteriaEntry"},"description":"<para type=\"description\">IPv6 criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed IPs Criteria</para>\r\n<para type=\"description\"></para>"},"IPv4CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv4 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"IPv6CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv6 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"HardwareIDsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Hardware IDs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/HardwareIDCriteriaEntry"},"description":"<para type=\"description\">Hardware IDs criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware IDs Criteria</para>\r\n<para type=\"description\"></para>"},"HardwareIDCriteriaEntry":{"type":"object","properties":{"hardwareID":{"type":"string","description":"<para type=\"description\">The hardware ID.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware ID criteria entry</para>\r\n<para type=\"description\"></para>"},"AccessType":{"enum":[["0 = DenyCriteriaWhen","1 = AllowCriteriaWhen"]],"type":"string","description":"<para type=\"synopsis\">Access type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"DevicesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Devices Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/ClientDeviceCriteriaEntry"},"description":"<para type=\"description\">Client criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Devices Criteria</para>\r\n<para type=\"description\"></para>"},"ClientDeviceCriteriaEntry":{"type":"object","properties":{"client":{"type":"string","description":"<para type=\"description\">The name of the client device.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Client device criteria entry</para>\r\n<para type=\"description\"></para>"},"ThemesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Themes Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">Theme criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Themes Criteria</para>\r\n<para type=\"description\"></para>"},"DefaultAssignmentType":{"enum":[["0 = Deny","1 = Allow"]],"type":"string","description":"<para type=\"synopsis\">Default assignment type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"Windows":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"},"useIfAvailable":{"type":"boolean","description":"<para type=\"description\">Use the following application if available on local device.</para>"},"target":{"type":"string","description":"<para type=\"description\">Application target file. (i.e. calc.exe, file.txt, etc.).</para>","nullable":true},"startIn":{"type":"string","description":"<para type=\"description\">Application working directory.</para>","nullable":true},"parameters":{"type":"string","description":"<para type=\"description\">Application parameters.</para>","nullable":true},"winType":{"$ref":"#/components/schemas/WindowType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Windows.</para>\r\n<para type=\"description\"></para>"},"Mac":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Mac.</para>\r\n<para type=\"description\"></para>"},"Linux":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Linux.</para>\r\n<para type=\"description\"></para>"},"iOS":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - iOS.</para>\r\n<para type=\"description\"></para>"},"Android":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Android.</para>\r\n<para type=\"description\"></para>"},"UserPortal":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Web Client.</para>\r\n<para type=\"description\"></para>"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## List

> Retrieve a list of all the published Local applications

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/Apps/Local":{"get":{"tags":["3-Publishing/Applications//Local"],"summary":"List","description":"Retrieve a list of all the published Local applications","operationId":"2246db7a-7240-46d7-b8d8-fc67fdc0bb22","parameters":[{"name":"SiteId","in":"query","description":"Site ID for which to retrieve all the published Local applications (optional)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PubLocalApp"}}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"PubLocalApp":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"name":{"type":"string","description":"<para type=\"description\">Name of the published item.</para>","nullable":true},"type":{"$ref":"#/components/schemas/RASPubObject"},"parentId":{"type":"integer","description":"<para type=\"description\">ID of the parent folder of the published item.</para>","format":"int32"},"previousId":{"type":"integer","description":"<para type=\"description\">ID of the previous published item.</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Description of the published item.</para>","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the published item is enabled or not.</para>"},"publishToSite":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">List of the IDs of all the sites this item is published to.</para>","nullable":true},"filter":{"$ref":"#/components/schemas/PubItemFilter"},"startOnLogon":{"type":"boolean","description":"<para type=\"description\">Whether the 'Start automatically when user logs on' option is enabled or disabled.</para>"},"inheritShortcutDefaultSettings":{"type":"boolean","description":"<para type=\"description\">Whether to inherit default shortcut settings or not.</para>"},"createShortcutOnDesktop":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut on the desktop or not.</para>"},"createShortcutInStartFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the start folder or not.</para>"},"startPath":{"type":"string","description":"<para type=\"description\">Starting path of the published item.</para>","nullable":true},"createShortcutInStartUpFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the startup folder or not.</para>"},"replicateShortcutSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate shortcut settings or not.</para>"},"url":{"type":"string","description":"<para type=\"description\">URL.</para>","nullable":true},"windows":{"$ref":"#/components/schemas/Windows"},"mac":{"$ref":"#/components/schemas/Mac"},"linux":{"$ref":"#/components/schemas/Linux"},"iOS":{"$ref":"#/components/schemas/iOS"},"android":{"$ref":"#/components/schemas/Android"},"userPortal":{"$ref":"#/components/schemas/UserPortal"},"replicateLocalAppSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate local application settings or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Published Local Application</para>\r\n<para type=\"description\"></para>"},"RASPubObject":{"enum":[["0 = Any","1 = Folder","2 = RDSApp","3 = RDSDesktop","4 = VDIDesktop","5 = PCDesktop","6 = PCApp","7 = VDIApp","8 = AVDApp","9 = AVDDesktop","10 = LocalApp"]],"type":"string","description":"<para type=\"synopsis\">RAS Publishing Objects</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubResourceEnabledMode":{"enum":[["0 = Disabled","1 = Enabled","2 = Maintenance"]],"type":"string","description":"<para type=\"synopsis\">Published resource availability modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubItemFilter":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/PubItemRule"},"nullable":true},"default":{"$ref":"#/components/schemas/DefaultAssignmentType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">The PubItem Filter object.</para>\r\n<para type=\"description\"></para>"},"PubItemRule":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"priority":{"type":"integer","description":"<para type=\"description\">Priority of the object.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Rule is enabled or not</para>"},"name":{"type":"string","description":"<para type=\"description\">Name of the Rule</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Rule</para>","nullable":true},"criteria":{"$ref":"#/components/schemas/PubItemCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Rule</para>\r\n<para type=\"description\"></para>"},"PubItemCriteria":{"type":"object","properties":{"securityPrincipals":{"$ref":"#/components/schemas/SecurityPrincipalsCriteria"},"gateways":{"$ref":"#/components/schemas/GatewaysCriteria"},"oSs":{"$ref":"#/components/schemas/OSsCriteria"},"iPs":{"$ref":"#/components/schemas/IPsCriteria"},"hardwareIDs":{"$ref":"#/components/schemas/HardwareIDsCriteria"},"access":{"$ref":"#/components/schemas/AccessType"},"devices":{"$ref":"#/components/schemas/DevicesCriteria"},"themes":{"$ref":"#/components/schemas/ThemesCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Criteria</para>\r\n<para type=\"description\"></para>"},"SecurityPrincipalsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Security Principals Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/SecurityPrincipalCriteriaEntry"},"description":"<para type=\"description\">User criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principals Criteria</para>\r\n<para type=\"description\"></para>"},"MatchingModeType":{"enum":[["0 = IsNotOneOfTheFollowing","1 = IsOneOfTheFollowing"]],"type":"string","description":"<para type=\"synopsis\">Matching mode type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"SecurityPrincipalCriteriaEntry":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principal Criteria Entry</para>\r\n<para type=\"description\"></para>"},"UserType":{"enum":[["1 = User","2 = Group","3 = ForeignSecurityPrincipal","4 = Computer"]],"type":"string","description":"<para type=\"synopsis\">User Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"GatewaysCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Gateways Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/GatewayCriteriaEntry"},"description":"<para type=\"description\">Gateway criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateways Criteria</para>\r\n<para type=\"description\"></para>"},"GatewayCriteriaEntry":{"type":"object","properties":{"gatewayIP":{"type":"string","description":"<para type=\"description\">The gateway IP.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateway criteria entry</para>\r\n<para type=\"description\"></para>"},"OSsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the OSs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedOSes":{"$ref":"#/components/schemas/AllowedOperatingSystems"}},"additionalProperties":false,"description":"<para type=\"synopsis\">OS Criteria Settings</para>\r\n<para type=\"description\"></para>"},"AllowedOperatingSystems":{"type":"object","properties":{"chrome":{"type":"boolean","description":"<para type=\"description\">Whether Chrome is allowed or not.</para>"},"android":{"type":"boolean","description":"<para type=\"description\">Whether Android is allowed or not.</para>"},"webClient":{"type":"boolean","description":"<para type=\"description\">Whether Web Client is allowed or not.</para>"},"iOS":{"type":"boolean","description":"<para type=\"description\">Whether iOS is allowed or not.</para>"},"linux":{"type":"boolean","description":"<para type=\"description\">Whether Linux is allowed or not.</para>"},"mac":{"type":"boolean","description":"<para type=\"description\">Whether MAC OS is allowed or not.</para>"},"wyse":{"type":"boolean","description":"<para type=\"description\">Whether Wyse is allowed or not.</para>"},"windows":{"type":"boolean","description":"<para type=\"description\">Whether Windows is allowed or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed Operating Systems</para>\r\n<para type=\"description\"></para>"},"IPsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the IPs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedIPs":{"$ref":"#/components/schemas/AllowedIPsCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPs Criteria</para>\r\n<para type=\"description\"></para>"},"AllowedIPsCriteria":{"type":"object","properties":{"iPv4s":{"type":"array","items":{"$ref":"#/components/schemas/IPv4CriteriaEntry"},"description":"<para type=\"description\">IPv4 criteria list</para>","nullable":true},"iPv6s":{"type":"array","items":{"$ref":"#/components/schemas/IPv6CriteriaEntry"},"description":"<para type=\"description\">IPv6 criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed IPs Criteria</para>\r\n<para type=\"description\"></para>"},"IPv4CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv4 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"IPv6CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv6 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"HardwareIDsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Hardware IDs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/HardwareIDCriteriaEntry"},"description":"<para type=\"description\">Hardware IDs criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware IDs Criteria</para>\r\n<para type=\"description\"></para>"},"HardwareIDCriteriaEntry":{"type":"object","properties":{"hardwareID":{"type":"string","description":"<para type=\"description\">The hardware ID.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware ID criteria entry</para>\r\n<para type=\"description\"></para>"},"AccessType":{"enum":[["0 = DenyCriteriaWhen","1 = AllowCriteriaWhen"]],"type":"string","description":"<para type=\"synopsis\">Access type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"DevicesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Devices Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/ClientDeviceCriteriaEntry"},"description":"<para type=\"description\">Client criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Devices Criteria</para>\r\n<para type=\"description\"></para>"},"ClientDeviceCriteriaEntry":{"type":"object","properties":{"client":{"type":"string","description":"<para type=\"description\">The name of the client device.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Client device criteria entry</para>\r\n<para type=\"description\"></para>"},"ThemesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Themes Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">Theme criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Themes Criteria</para>\r\n<para type=\"description\"></para>"},"DefaultAssignmentType":{"enum":[["0 = Deny","1 = Allow"]],"type":"string","description":"<para type=\"synopsis\">Default assignment type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"Windows":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"},"useIfAvailable":{"type":"boolean","description":"<para type=\"description\">Use the following application if available on local device.</para>"},"target":{"type":"string","description":"<para type=\"description\">Application target file. (i.e. calc.exe, file.txt, etc.).</para>","nullable":true},"startIn":{"type":"string","description":"<para type=\"description\">Application working directory.</para>","nullable":true},"parameters":{"type":"string","description":"<para type=\"description\">Application parameters.</para>","nullable":true},"winType":{"$ref":"#/components/schemas/WindowType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Windows.</para>\r\n<para type=\"description\"></para>"},"WindowType":{"enum":[["0 = Normal","1 = Maximized","2 = Minimized"]],"type":"string","description":"<para type=\"synopsis\">Published application window type</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"Mac":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Mac.</para>\r\n<para type=\"description\"></para>"},"Linux":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Linux.</para>\r\n<para type=\"description\"></para>"},"iOS":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - iOS.</para>\r\n<para type=\"description\"></para>"},"Android":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Android.</para>\r\n<para type=\"description\"></para>"},"UserPortal":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the application is enabled for the operating system or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Local Application - Web Client.</para>\r\n<para type=\"description\"></para>"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Update

> Modify properties of a published Local application.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/{id}/Apps/Local":{"put":{"tags":["3-Publishing/Applications//Local"],"summary":"Update","description":"Modify properties of a published Local application.","operationId":"520c53f6-b349-44b1-9fec-9667f6b94a55","parameters":[{"name":"id","in":"path","description":"ID of the published Local application to be updated","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Published Local application configuration","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/SetPubLocalApp"}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"SetPubLocalApp":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">A new name to assign to the published resource.</para>","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"description":{"type":"string","description":"<para type=\"description\">Published resource description.</para>","nullable":true},"publishToSiteIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">An array of sites to which to publish a resource.</para>","nullable":true},"preferredRoutingEnabled":{"type":"boolean","description":"<para type=\"description\">Enable or disable Preferred Routing.</para>","nullable":true},"replicateShortcutSettings":{"type":"boolean","description":"<para type=\"description\">Replicate shortcut settings to all sites.</para>","nullable":true},"createShortcutOnDesktop":{"type":"boolean","description":"<para type=\"description\">Create a shortcut on a client's desktop.</para>","nullable":true},"createShortcutInStartFolder":{"type":"boolean","description":"<para type=\"description\">Create a shortcut in the client's Start folder.</para>","nullable":true},"createShortcutInStartUpFolder":{"type":"boolean","description":"<para type=\"description\">Create a shortcut in the client's Auto Start folder.</para>","nullable":true},"startPath":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Specifies the path in the Start folder where the shortcut will be created.</para>","nullable":true},"inheritShortcutDefaultSettings":{"type":"boolean","description":"<para type=\"description\">Inherit default shortcut settings.</para>","nullable":true},"startOnLogon":{"type":"boolean","description":"<para type=\"description\">Start a resource automatically when a user logs on.</para>","nullable":true},"excludePrelaunch":{"type":"boolean","description":"<para type=\"description\">Exclude application from prelaunch.</para>","nullable":true},"url":{"type":"string","description":"<para type=\"description\">URL.</para>","nullable":true},"windowsEnabled":{"type":"boolean","description":"<para type=\"description\">Windows: Whether the application is enabled for the operating system or not.</para>","nullable":true},"windowsUseIfAvailable":{"type":"boolean","description":"<para type=\"description\">Windows: Use the following application if available on local device.</para>","nullable":true},"windowsStartIn":{"maxLength":260,"minLength":0,"type":"string","description":"<para type=\"description\">Windows: Application working directory.</para>","nullable":true},"windowsTarget":{"maxLength":260,"minLength":0,"type":"string","description":"<para type=\"description\">Windows: Application target file. (i.e. calc.exe, file.txt, etc.).</para>","nullable":true},"windowsParameters":{"maxLength":1024,"minLength":0,"type":"string","description":"<para type=\"description\">Windows: Application parameters.</para>","nullable":true},"windowsWinType":{"$ref":"#/components/schemas/WindowType"},"macEnabled":{"type":"boolean","description":"<para type=\"description\">Mac: Whether the application is enabled for the operating system or not.</para>","nullable":true},"linuxEnabled":{"type":"boolean","description":"<para type=\"description\">Linux: Whether the application is enabled for the operating system or not.</para>","nullable":true},"iOSEnabled":{"type":"boolean","description":"<para type=\"description\">iOS: Whether the application is enabled for the operating system or not.</para>","nullable":true},"androidEnabled":{"type":"boolean","description":"<para type=\"description\">Android: Whether the application is enabled for the operating system or not.</para>","nullable":true},"userPortalEnabled":{"type":"boolean","description":"<para type=\"description\">UserPortal: Whether the application is enabled for the operating system or not.</para>","nullable":true},"replicateLocalAppSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate local application settings or not.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Update settings of a local application</para>\r\n<para type=\"description\"></para>"},"PubResourceEnabledMode":{"enum":[["0 = Disabled","1 = Enabled","2 = Maintenance"]],"type":"string","description":"<para type=\"synopsis\">Published resource availability modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowType":{"enum":[["0 = Normal","1 = Maximized","2 = Minimized"]],"type":"string","description":"<para type=\"synopsis\">Published application window type</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Delete

> Delete a published application from a site.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/{id}/Apps/Local":{"delete":{"tags":["3-Publishing/Applications//Local"],"summary":"Delete","description":"Delete a published application from a site.","operationId":"0fb28e2e-7169-4077-813c-b680d66af8a3","parameters":[{"name":"id","in":"path","description":"ID of the published Local application to be deleted","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```