DocumentationDynamic Media Image Production System API

moveFolder

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Move a folder to a new location.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (moveFolderParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Handle to the company.
folderHandle
xsd:string
Yes
Folder handle.
destFolderHandle
xsd:string
Yes
Handle to the destination folder.

Output (moveFolderReturn)

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

Examples

Request

<moveFolderParam xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
   <companyHandle>c|101</companyHandle>
   <folderHandle>f|test/MoveTest/</folderHandle>
   <destFolderHandle>f|DevanCo/DestFolder/</destFolderHandle>
</moveFolderParam>

Response

<moveFolderReturn xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
   <folderHandle>f|test/DestFolder/MoveTest/</folderHandle>
</moveFolderReturn>
4e9b9d8c-5839-4215-aa35-01b652869681