Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Expand SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Collapse PDM Pro API Web ServicePDM Pro API Web Service
Overview
Welcome
Getting Started
Release Notes
Collapse ResourceGroupsResourceGroups
Expand Authentication Resource GroupAuthentication Resource Group
Expand BOM Resource GroupBOM Resource Group
Expand Configuration Resource GroupConfiguration Resource Group
Expand Data Card Resource GroupData Card Resource Group
Expand Default Resource GroupDefault Resource Group
Collapse File Resource GroupFile Resource Group
Overview
Collapse OperationsOperations
api/{vaultName}/files/{fileId}/{folderId}/bominfo (Get)
api/{vaultName}/files/{fileId}/{folderId}/history (Get)
api/{vaultName}/files/{fileId}/{folderId}/moves (Get)
api/{vaultName}/files/{fileId}/{folderId}/versions (Get)
api/{vaultName}/files/{fileId}/{folderId}?destroy={destroy} (Delete)
api/{vaultName}/files/{fileId}/{version}/{configId}/{folderId}/whereused?anyVersion={anyVersion} (Get)
api/{vaultName}/files/{fileId}/{version}/{configId}/whereused?folderId={folderId}? (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/ActiveConfig (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/allreferences?configId={configId}? (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/configurations (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/download (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/info (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/info/extended (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/references?configId={configId} (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/thumbnails (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/transitions (Get)
api/{vaultName}/files/{fileId}/{version}/{folderId}/variables (Get)
api/{vaultName}/files/{fileId}/{version}/ActiveConfig?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/allreferences?configId={configId}? (Get)
api/{vaultName}/files/{fileId}/{version}/configurations?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/download?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/info/extended?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/info?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/references?configId={configId}? (Get)
api/{vaultName}/files/{fileId}/{version}/thumbnails?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/transitions?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/variables?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/{version}/whereused?configId={configId}? (Get)
api/{vaultName}/files/{fileId}/{version}?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/bominfo?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/history?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/info?version={version}? (Get)
api/{vaultName}/files/{fileId}/moves?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}/transitions?version={version}? (Get)
api/{vaultName}/files/{fileId}/versions?folderId={folderId} (Get)
api/{vaultName}/files/{fileId}?folderId={folderId}? (Delete)
api/{vaultName}/files/{fileId}?version={version}? (Get)
api/{vaultName}/files/buildtree/checkout (Post)
api/{vaultName}/files/buildtree/undo (Post)
api/{vaultName}/files/CheckOut (Post)
api/{vaultName}/files/info (Post)
api/{vaultName}/files/infofrompath (Post)
api/{vaultName}/files/UndoCheckOut (Post)
Expand Folder Resource GroupFolder Resource Group
Expand Group Resource GroupGroup Resource Group
Expand Notification Resource GroupNotification Resource Group
Expand Progress Resource GroupProgress Resource Group
Expand Stage Resource GroupStage Resource Group
Expand State Transition Resource GroupState Transition Resource Group
Expand User Resource GroupUser Resource Group
Expand Vault Resource GroupVault Resource Group
Expand Version Resource GroupVersion Resource Group
Expand Workflow Resource GroupWorkflow Resource Group
Expand Search Resource GroupSearch Resource Group
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
PDM Pro API Web Service
Getapi/{vaultName}/files/{fileId}?version={version}&folderId={folderId}
PDM Pro API Web Service > File Resource Group : api/{vaultName}/files/{fileId}?version={version}&folderId={folderId} (Get)
Description
Gets information about the specified file.
Parameters
NameDescriptionData Type
vaultName(Required URI Parameter) Vault namestring
fileId(Required URI Parameter) File IDinteger
version(URI Parameter) File version, default value is 0integer
folderId(URI Parameter) Folder ID, default value is 0integer
Id

(Response) File ID

(Member of ObjectInfo model)

integer
Name

(Response) File name

(Member of ObjectInfo model)

string
Size

(Response) File size

(Member of ObjectInfo model)

integer
ModifiedDate

(Response) Modified date

(Member of ObjectInfo model)

date
State

(Response) File state

(Member of ObjectInfo model)

string
StateId

(Response) File 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) Object Type:

   Folder = 0

   File = 1

   Bom = 3

(Member of ObjectInfo model)

ObjectType
IsLocked

(Response) Whether file is locked (checked out)

(Member of ObjectInfo model)

integer
LockedBy

(Response) ID of user who checked out the file

(Member of ObjectInfo model)

integer
IsShared

(Response) Whether the file is shared

(Member of ObjectInfo model)

integer
IsToolbox

(Response) 1 if a ToolBox item, 0 if not

(Member of ObjectInfo model)

integer
IsDeleted

(Response) Whether file 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:00.8951066-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:00.8951066-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:00.8951066-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:00.8951066-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>
See Also
File 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}/files/{fileId}?version={version}&folderId={folderId} (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 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.

0.20.20