Hide Table of Contents
PDM Pro API Web Service
Deleteapi/{vaultName}/folders/{folderId}?destroy={destroy}
PDM Pro API Web Service > Folder Resource Group : api/{vaultName}/folders/{folderId}?destroy={destroy} (Delete)
Description
Delete folder

 

Deletes the specified folder.

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string
(URI parameter) Folder ID (required)integer
(URI parameter) Whether to delete the folder (default value is false)boolean

(Response) Deleted folder ID

 

Member of ObjectInfoShort model

integer

(Response) Deleted folder name

 

 

Member of ObjectInfoShort model

string

(Response) An ObjectType object; one of:

   Folder = 0

   File = 1

   Bom = 3

 

 

Member of ObjectInfoShort model

ObjectType

(Response) A StatusOperation object; one of:

   Success = 0

   Failure = 1

 

 

Member of ObjectInfoShort model

StatusOperation

(Response) A BaseWarningModel object that consists of:

   Message (string)

   IsBlocking (boolean)

   IsError (boolean)

 

 

Member of ObjectInfoShort model

BaseWarningModel
Response (application/json, text/json)

Sample Data

{
  "Id": 1,
  "Name": "sample string 2",
  "Type": 0,
  "Status": 0,
  "Warning": null
}
Response (application/xml, text/xml)

Sample Data

<ObjectInfoShort xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <Id>1</Id>
  <Name>sample string 2</Name>
  <Status>Success</Status>
  <Type>Folder</Type>
  <Warning i:nil="true" />
</ObjectInfoShort>
See Also


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   api/{vaultName}/folders/{folderId}?destroy={destroy} (Delete)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:




x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2022 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.