Hide Table of Contents
PDM Pro API Web Service
Getapi/{vaultName}
Description
Get vault properties

 

Gets the properties of the specified vault.

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string

(Response) Vault version

 

Member of VaultProp model

integer

(Response) Type of vault

 

 

Member of VaultProp model

 

string

(Response) Archive server

 

 

Member of VaultProp model

 

string

(Response) Database name

 

 

Member of VaultProp model

 

string

(Response) Database server

 

 

Member of VaultProp model

 

string

(Response) Vault ID

 

 

Member of VaultProp model

 

globally unique identifier
Response (application/json, text/json)

Sample Data

{
  "Version": 1,
  "VaultType": "sample string 2",
  "ArchiveServer": "sample string 3",
  "DatabaseName": "sample string 4",
  "DatabaseServer": "sample string 5",
  "VaultID": "d440c718-67c4-47f1-b285-eccd73d50339"
}
Response (application/xml, text/xml)

Sample Data

<VaultProp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <ArchiveServer>sample string 3</ArchiveServer>
  <DatabaseName>sample string 4</DatabaseName>
  <DatabaseServer>sample string 5</DatabaseServer>
  <VaultID>d440c718-67c4-47f1-b285-eccd73d50339</VaultID>
  <VaultType>sample string 2</VaultType>
  <Version>1</Version>
</VaultProp>
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} (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) 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.