Hide Table of Contents
PDM Pro API Web Service
Getapi/{vaultName}/folders/{folderId}/browse
PDM Pro API Web Service > Folder Resource Group : api/{vaultName}/folders/{folderId}/browse (Get)
Description
GET: api/{VaultName}/folders/{FolderID}/browse Get browse folder

 

Gets the files and folders in the specified folder.

Parameters
NameDescriptionData Type
vaultName(URI parameter) Vault  name (required)string
folderId(URI parameter) ID of folder in which to browse (required)integer
Id

(Response) ID of object

 

Member of ObjectInfo model

integer
Name

(Response) Name of object

 

Member of ObjectInfo model

 

string
Size

(Response) Size of object

 

Member of ObjectInfo model

 

integer
ModifiedDate

(Response) Modification date

 

Member of ObjectInfo model

 

date
Version

(Response) Version

 

Member of ObjectInfo model

 

integer
State

(Response) State

 

Member of ObjectInfo model

 

string
StateId

(Response) State ID

 

Member of ObjectInfo model

 

integer
ParentFolderId

(Response) Parent folder ID

 

Member of ObjectInfo model

 

integer
Path

(Response) Folder path

 

Member of ObjectInfo model

 

string
Type

(Response) An ObjectType; one of:

   Folder = 0

   File = 1

   Bom = 3

 

Member of ObjectInfo model

 

ObjectType
IsLocked

(Response) Whether the object is locked

 

Member of ObjectInfo model

 

integer
LockedBy

(Response) Locked by user

 

Member of ObjectInfo model

 

integer
IsShared

(Response) Whether the object is shared

 

Member of ObjectInfo model

 

integer
IsToolbox

(Response) Whether the object is in the toolbox

 

Member of ObjectInfo model

 

integer
IsDeleted

(Response) Whether the object is deleted

 

Member of ObjectInfo model

 

integer
Response (application/json, text/json)

Sample Data

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Size": 3,
    "ModifiedDate": "2024-02-26T09:21:01.5746707-05:00",
    "Version": 5,
    "State": "sample string 6",
    "StateId": 7,
    "ParentFolderId": 8,
    "Path": "sample string 9",
    "Type": 0,
    "IsLocked": 10,
    "LockedBy": 11,
    "IsShared": 12,
    "IsToolbox": 13,
    "IsDeleted": 14
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Size": 3,
    "ModifiedDate": "2024-02-26T09:21:01.5746707-05:00",
    "Version": 5,
    "State": "sample string 6",
    "StateId": 7,
    "ParentFolderId": 8,
    "Path": "sample string 9",
    "Type": 0,
    "IsLocked": 10,
    "LockedBy": 11,
    "IsShared": 12,
    "IsToolbox": 13,
    "IsDeleted": 14
  }
]
Response (application/xml, text/xml)

Sample Data

<ArrayOfObjectInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <ObjectInfo>
    <Id>1</Id>
    <IsDeleted>14</IsDeleted>
    <IsLocked>10</IsLocked>
    <IsShared>12</IsShared>
    <IsToolbox>13</IsToolbox>
    <LockedBy>11</LockedBy>
    <ModifiedDate>2024-02-26T09:21:01.5746707-05:00</ModifiedDate>
    <Name>sample string 2</Name>
    <ParentFolderId>8</ParentFolderId>
    <Path>sample string 9</Path>
    <Size>3</Size>
    <State>sample string 6</State>
    <StateId>7</StateId>
    <Type>Folder</Type>
    <Version>5</Version>
  </ObjectInfo>
  <ObjectInfo>
    <Id>1</Id>
    <IsDeleted>14</IsDeleted>
    <IsLocked>10</IsLocked>
    <IsShared>12</IsShared>
    <IsToolbox>13</IsToolbox>
    <LockedBy>11</LockedBy>
    <ModifiedDate>2024-02-26T09:21:01.5746707-05:00</ModifiedDate>
    <Name>sample string 2</Name>
    <ParentFolderId>8</ParentFolderId>
    <Path>sample string 9</Path>
    <Size>3</Size>
    <State>sample string 6</State>
    <StateId>7</StateId>
    <Type>Folder</Type>
    <Version>5</Version>
  </ObjectInfo>
</ArrayOfObjectInfo>
Example
See the examples for api/{vaultName}/authenticate.
Example
Modify File Datacards.postman_collection.json
Remarks
This operation returns an array of ObjectInfo objects.
See Also
Folder Resource Group | PDM Pro API Web Service



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}/browse (Get)
*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) 2024 SP03

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.

0.20.36