Hide Table of Contents
PDM Pro API Web Service
Putapi/{vaultName}/folders/{parentFolderId}
PDM Pro API Web Service > Folder Resource Group : api/{vaultName}/folders/{parentFolderId} (Put)
Description
Add folder

 

Adds a folder to the specified folder.

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string
(URI parameter) Parent folder ID (required)integer

(Response) Created folder ID

 

Member of ObjectInfoShort model

integer

(Response) Created 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
Request (application/json, text/json)

Sample Data

"sample string 1"
Request (application/xml, text/xml)

Sample Data

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>
Request (application/x-www-form-urlencoded)

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>
Remarks
This operation takes a string body parameter that is the name of the folder to add.
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/{parentFolderId} (Put)
*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 SP04

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.