Copy

PreviousClient Filters NextFilter

Was this helpful?

Copy

Copy (duplicate) a published item.

POST/api/PubItems/{id}/Copy

Path parameters

id*integer (int32)

ID of Pub item to duplicate.

Body

The Published item to be copied.

parentIdinteger (int32)

ID of a new parent published item. To obtain the published item ID, use the Get-PubItem command.

previousIdinteger (int32)

ID of a sibling item after which to place the specified published item. To obtain the sibling item ID, use the Get-PubItem command.

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.

maintenanceMessagesobject

Contains a set of maintenance messages in various languages

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeenum

RAS Publishing Objects

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

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.

enabledModeenum

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.

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of object

Lists the allowed users (deprecated).

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of object

Lists the allowed IPv4 addresses (deprecated).

allowedIP6snullable array of object

Lists the allowed IPV6 addresses (deprecated).

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesobject

Allowed Operating Systems

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of object

The list of Preferred Routes.

filterobject

The PubItem Filter object.

Request

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

Response

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T03:49:59.440Z",
  "timeLastMod": "2025-02-05T03:49:59.440Z",
  "maintenanceMessages": {
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "maintenanceMessage_de_DE": "text"
  },
  "inheritMaintenance": true,
  "replicateMaintenance": true,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": true,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": true,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": true,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": true,
  "allowedMACs": [
    "text"
  ],
  "gatewayFilterEnabled": true,
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": true,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "webClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "wyse": true,
    "windows": true
  },
  "preferredRoutingEnabled": true,
  "preferredRoutes": [
    {
      "id": 1,
      "priority": 1,
      "name": "text",
      "description": "text",
      "enabled": true,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ],
      "referenceId": 1
    }
  ],
  "filter": {
    "rules": [
      {
        "id": 1,
        "priority": 1,
        "enabled": true,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": true,
              "android": true,
              "webClient": true,
              "iOS": true,
              "linux": true,
              "mac": true,
              "wyse": true,
              "windows": true
            }
          },
          "iPs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": [
              1
            ]
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  }
}