Folders

PreviousFilter NextSort

Was this helpful?

List

Retrieve a list of all the published folders

GET/api/PubItems/Folders

Query parameters

Response

Success

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.

adminOnlyboolean

Whether there are admin rights only for this folder or not.

Request

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

Response

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-02-05T01:01:40.170Z",
    "timeLastMod": "2025-02-05T01:01:40.170Z",
    "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"
      ]
    },
    "adminOnly": true
  }
]

Create

Add a published folder to a site.

POST/api/PubItems/Folders

Body

Published folder configuration

name*nullable string

Published resource name.

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

replicateMaintenancenullable boolean

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

inheritMaintenancenullable boolean

Whether to inherit default Maintenance settings.

enabledModeenum

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

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

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.

adminOnlyboolean

Use folder for administrative purposes only.

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.

adminOnlyboolean

Whether there are admin rights only for this folder or not.

Request

const response = await fetch('/api/PubItems/Folders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text",
      "enabledMode": [
        "0 = Disabled",
        "1 = Enabled",
        "2 = Maintenance"
      ],
      "publishToSiteIds": [
        null
      ],
      "adminOnly": false
    }),
});
const data = await response.json();

Response

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T01:01:40.170Z",
  "timeLastMod": "2025-02-05T01:01:40.170Z",
  "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"
    ]
  },
  "adminOnly": true
}

Get

Retrieve information about a specified published folder.

GET/api/PubItems/{id}/Folders

Path parameters

id*integer (int32)

ID of the published folder to be retrieved

Response

Success

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.

adminOnlyboolean

Whether there are admin rights only for this folder or not.

Request

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

Response

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T01:01:40.170Z",
  "timeLastMod": "2025-02-05T01:01:40.170Z",
  "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"
    ]
  },
  "adminOnly": true
}

Update

Modify properties of a published folder.

PUT/api/PubItems/{id}/Folders

Path parameters

id*integer (int32)

ID of the published folder to be updated

Body

Published folder configuration

namenullable string

A new name to assign to the published resource.

replicateMaintenancenullable boolean

Replicate Maintenance

inheritMaintenancenullable boolean

Inherit Maintenance

enabledModeenum

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

adminOnlynullable boolean

Use folder for administrative purposes only.

Response

No Content

Request

const response = await fetch('/api/PubItems/{id}/Folders', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "enabledMode": [
        "0 = Disabled",
        "1 = Enabled",
        "2 = Maintenance"
      ],
      "publishToSiteIds": [
        null
      ]
    }),
});
const data = await response.json();

Response

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

Delete

Delete a published folder

DELETE/api/PubItems/{id}/Folders

Path parameters

id*integer (int32)

ID of the published folder to be deleted

Response

No Content

Request

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

Response

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