DocumentationDynamic Media Image Production System API

createFolder createfolder

Last update: Fri Nov 11 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Creates a folder.

NOTE
The new folder is subordinate to the Images folder, even if you specify a / to indicate the root of the company.

Syntax

Authorized User Types section-14ef6368056b4e8f96198c20b6d93b9b

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
The user must have read/write access to the parent folder.

Parameters section-c00d8d89cf114886a535056f2a1bf892

Input (createFolder)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The Handle to the company
folderPath
xsd:string
Yes
The root folder used to retrieve folders and all subfolders to the leaf level. If excluded, the company root is used.

Output (createFolderParam)

Name
Type
Required
Description
folderHandle
xsd:string
Yes
Handle of the new folder.

Examples section-e596fbdb44fd43c8b30005cb2a2fdf26

This sample code creates a folder at the root of a company. The response returns the handle of the newly created folder.

Request

<ns1:createFolderParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:folderPath>/SpinSets</ns1:folderPath>
</ns1:createFolderParam>

Response

<ns1:createFolderReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <folderHandle xmlns="http://www.scene7.com/IpsApi/xsd">MyCompany/SpinSets/</folderHandle>
</ns1:createFolderReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681