Show Menu
TOPICS×

deleteProject

Deletes a project from a company. The links between the assets and the project are broken, but the assets are not deleted from IPS.
Syntax

Authorized User Types

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

Parameters

Input (deleteProjectParam)
Name
Type
Required
Description
* companyName *
xsd:string
Yes
The name of the company associated with the project.
* projectHandle *
xsd:string
Yes
The handle to the project to be deleted.
Output (deleteProjectReturn)
The IPS API does not return a response for this operation.

Examples

This code sample uses the company handle and the project handle as fields in the deleteProjectParam sent to the IPS Web services server in order to delete the project.
Request
<deleteProjectParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
<projectHandle>p|6|ProjectTestAPI</projectHandle></deleteProjectParam>

Response
None.