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

 

Gets the specified file's variables.

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string
(URI parameter) File ID (required)integer
(URI parameter) File version (required)integer

(Response) Configuration name

 

Member of ConfigInfo model (see Remarks)

string

(Response) Configuration ID

 

Member of ConfigInfo model (see Remarks)

integer

(Response) Array of VariableInfos; each VariableInfo consists of:

 

   VarId (integer)

   VarName (string)

   VarValue (string)

   VarType (one of:

       VarTypeNone = 0

       VarTypeText = 1

       VarTypeInt = 2

       VarTypeFloat = 3

       VarTypeBool = 4

       VarTypeDate = 5

   Mandatory (boolean)

   VersionFree (boolean)

 

 

Member of ConfigInfo model (see Remarks)

 

Collection of VariableInfo
Response (application/json, text/json)

Sample Data

[
  {
    "Models": [
      {
        "VarId": 1,
        "VarName": "sample string 2",
        "VarValue": "sample string 3",
        "VarType": 0,
        "Mandatory": true,
        "VersionFree": true
      },
      {
        "VarId": 1,
        "VarName": "sample string 2",
        "VarValue": "sample string 3",
        "VarType": 0,
        "Mandatory": true,
        "VersionFree": true
      }
    ],
    "ConfigurationName": "sample string 1",
    "ConfigurationId": 2
  },
  {
    "Models": [
      {
        "VarId": 1,
        "VarName": "sample string 2",
        "VarValue": "sample string 3",
        "VarType": 0,
        "Mandatory": true,
        "VersionFree": true
      },
      {
        "VarId": 1,
        "VarName": "sample string 2",
        "VarValue": "sample string 3",
        "VarType": 0,
        "Mandatory": true,
        "VersionFree": true
      }
    ],
    "ConfigurationName": "sample string 1",
    "ConfigurationId": 2
  }
]
Response (application/xml, text/xml)

Sample Data

<ArrayOfConfigInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <ConfigInfo>
    <ConfigurationId>2</ConfigurationId>
    <ConfigurationName>sample string 1</ConfigurationName>
    <Models>
      <VariableInfo>
        <Mandatory>true</Mandatory>
        <VarId>1</VarId>
        <VarName>sample string 2</VarName>
        <VarType>VarTypeNone</VarType>
        <VarValue>sample string 3</VarValue>
        <VersionFree>true</VersionFree>
      </VariableInfo>
      <VariableInfo>
        <Mandatory>true</Mandatory>
        <VarId>1</VarId>
        <VarName>sample string 2</VarName>
        <VarType>VarTypeNone</VarType>
        <VarValue>sample string 3</VarValue>
        <VersionFree>true</VersionFree>
      </VariableInfo>
    </Models>
  </ConfigInfo>
  <ConfigInfo>
    <ConfigurationId>2</ConfigurationId>
    <ConfigurationName>sample string 1</ConfigurationName>
    <Models>
      <VariableInfo>
        <Mandatory>true</Mandatory>
        <VarId>1</VarId>
        <VarName>sample string 2</VarName>
        <VarType>VarTypeNone</VarType>
        <VarValue>sample string 3</VarValue>
        <VersionFree>true</VersionFree>
      </VariableInfo>
      <VariableInfo>
        <Mandatory>true</Mandatory>
        <VarId>1</VarId>
        <VarName>sample string 2</VarName>
        <VarType>VarTypeNone</VarType>
        <VarValue>sample string 3</VarValue>
        <VersionFree>true</VersionFree>
      </VariableInfo>
    </Models>
  </ConfigInfo>
</ArrayOfConfigInfo>
Remarks
This operation can return an array of ConfigInfos. See the Response examples.
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}/variables (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.