Hide Table of Contents
PDM Pro API Web Service
Getapi/{vaultName}/files/{fileId}?version={version}
PDM Pro API Web Service > File Resource Group : api/{vaultName}/files/{fileId}?version={version} (Get)
Description
Get file info

 

Gets information about the specified file.

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string
(URI parameter) File ID (required)integer
(URI and Response parameter) Version (default value is 0)integer

(Response) File ID

 

Member of ObjectInfo model; see Remarks

integer

(Response) File name

 

Member of ObjectInfo model; see Remarks

 

string

(Response) File size

 

Member of ObjectInfo model; see Remarks

 

integer

(Response) Modification date

 

Member of ObjectInfo model; see Remarks

 

date

(Response) Workflow state

 

Member of ObjectInfo model; see Remarks

 

string

(Response) State ID

 

Member of ObjectInfo model; see Remarks

 

integer

(Response) Parent folder ID

 

Member of ObjectInfo model; see Remarks

 

integer

(Response) Folder path

 

Member of ObjectInfo model; see Remarks

 

string

(Response) ObjectType model; one of:

   Folder = 0

   File = 1

   Bom = 3

 

Member of ObjectInfo model; see Remarks

 

ObjectType

(Response) Whether the file is checked out

 

Member of ObjectInfo model; see Remarks

 

integer

(Response) ID of user who checked out the file

 

Member of ObjectInfo model; see Remarks

 

integer

(Response) Whether the file is shared

 

Member of ObjectInfo model; see Remarks

 

integer

(Response) Whether the file is a toolbox item

 

Member of ObjectInfo model; see Remarks

 

integer

(Response) Whether the file is deleted

 

Member of ObjectInfo model; see Remarks

 

integer
Response (application/json, text/json)

Sample Data

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Size": 3,
    "ModifiedDate": "2022-07-25T14:02:49.4464064-04: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": "2022-07-25T14:02:49.4464064-04: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>2022-07-25T14:02:49.4464064-04: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>2022-07-25T14:02:49.4464064-04: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>
Remarks
This operation should return one ObjectInfo object for each unique file ID in the request URI.
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}/files/{fileId}?version={version} (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.