Documentation Dynamic Media Image Production System API

renameFolder

Last update: March 8, 2022

Topics:
Dynamic Media Classic,SDK/API,Asset Management

CREATED FOR:

Developer
Admin

Renames a folder.

Syntax

Authorized User Types

IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser

NOTE

The user must have read and write access to the asset.

Parameters

Input (renameFolderParam)

Name	Type	Required	Description
companyHandle	`xsd:string`	Yes	Handle to the company with folders you want to rename.
folderHandle	`xsd:string`	Yes	Handle to the folder.
folderName	`xsd:string`	Yes	New folder name.

Output (renameFolderReturn)

Name	Type	Required	Description
folderHandle	`xsd:string`	Yes	Handle to the renamed folder.

Examples

This code sample renames a folder.

Request

<ns1:renameFolderParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:folderHandle>MyCompany/PDF/</ns1:folderHandle>
   <ns1:folderName>My Newly Renamed PDF Folder</ns1:folderName>
</ns1:renameFolderParam>

Response

<renameFolderReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <folderHandle>MyCompany/My Newly Renamed PDF Folder/</folderHandle>
</renameFolderReturn>

recommendation-more-help