DocumentationDynamic Media Image Production System API

renameProject

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

CREATED FOR:

  • Developer
  • Admin

Renames a project.

Syntax

Authorized User Types

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

Parameters

Input (renameProjectParam)

Name
Type
Required
Description
companyName
xsd:string
Yes
Handle to the company with the project you want to rename.
projectHandle
xsd:string
Yes
Handle to the project.
projectName
xsd:string
Yes
New project name.

Output (renameProjectParam)

Name
Type
Required
Description
projectHandle
xsd:string
Yes
The handle of the renamed project.

Examples

This code sample renames a project and returns the project handle.

Request

<renameProjectParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
   <projectHandle>p|6|ApiTestProject</projectHandle>
   <projectName>ProjectTestAPI</projectName>
</renameProjectParam>

Response

<renameProjectReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <projectHandle>p|6|ProjectTestAPI</projectHandle>
</renameProjectReturn>
4e9b9d8c-5839-4215-aa35-01b652869681