DocumentationDynamic Media Image Production System API

removeFolderPermissions removefolderpermissions

Last update: Thu Aug 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Removes folder permissions.

Syntax

Authorized User Types section-bfa745624f9b43aaba6c226ac6700fe7

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters section-7efa68377fd846219b906d354ae64ed3

Input (removeFolderPermissionsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company with folders with permissions you want to remove.
folderHandle
xsd:string
Yes
Handle to the folder.
updateChildren
xsd:boolean
Yes

When true:

  • Permissions removal propagates through all folder permission operations.

When false:

  • The operation affects the specified folder only.

Output (removeFolderPermissionsReturn)

The IPS API does not return a response for this operation.

Examples section-04390f0ec7cc460cb5d34d518e33e7a5

This code sample removes permissions from a folder and its subfolders. Set updateChildren to false to remove permissions from the parent folder only.

Request

<removeFolderPermissionsParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>64</companyHandle>
   <folderHandle>blackmesa/Awatermark/</folderHandle>
   <updateChildren>true</updateChildren>
</removeFolderPermissionsParam>

Response

None.

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681