Hide Table of Contents
PDM Pro API Web Service
Getapi/configuration/vaults?vaultName={vaultName}
PDM Pro API Web Service > Configuration Resource Group : api/configuration/vaults?vaultName={vaultName} (Get)
Description
GET: api/configuration/vaults Get all vaults from the config file

 

Gets all vaults from the vault configuration file.

Parameters
NameDescriptionData Type
vaultName(URI parameter) Vault name (default is empty string)string
Name

(Response) Vault name matching regular expression pattern: ^[^|\\/:*?"<>|]+$

 

Member of VaultProperties model

See the Remarks.

 

string
DatabaseName

(Response) Database name matching regular expression pattern: ^[^|\\/:*?"<>|]+$

 

Member of VaultProperties model

See the Remarks.

 

string
ArchiveServer

Archive server name

 

Member of VaultProperties model

See the Remarks.

string
ArchiveServerPort

Archive server port

 

Member of VaultProperties model

See the Remarks.

integer
DatabaseServer

Database server

 

Member of VaultProperties model

See the Remarks.

string
CommandTimeOut

Length before time out (seconds)

 

Member of VaultProperties model

See the Remarks.

integer
IndexingUserId

Indexing user ID

 

Member of VaultProperties model

See the Remarks.

integer
Response (application/json, text/json)

Sample Data

[
  {
    "Name": "sample string 1",
    "DatabaseName": "sample string 2",
    "ArchiveServer": "sample string 3",
    "ArchiveServerPort": 4,
    "DatabaseServer": "sample string 5",
    "CommandTimeOut": 6,
    "IndexingUserId": 7
  },
  {
    "Name": "sample string 1",
    "DatabaseName": "sample string 2",
    "ArchiveServer": "sample string 3",
    "ArchiveServerPort": 4,
    "DatabaseServer": "sample string 5",
    "CommandTimeOut": 6,
    "IndexingUserId": 7
  }
]
Response (application/xml, text/xml)

Sample Data

<ArrayOfVaultProperties xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Configuration">
  <VaultProperties>
    <ArchiveServer>sample string 3</ArchiveServer>
    <ArchiveServerPort>4</ArchiveServerPort>
    <CommandTimeOut>6</CommandTimeOut>
    <DatabaseName>sample string 2</DatabaseName>
    <DatabaseServer>sample string 5</DatabaseServer>
    <IndexingUserId>7</IndexingUserId>
    <Name>sample string 1</Name>
  </VaultProperties>
  <VaultProperties>
    <ArchiveServer>sample string 3</ArchiveServer>
    <ArchiveServerPort>4</ArchiveServerPort>
    <CommandTimeOut>6</CommandTimeOut>
    <DatabaseName>sample string 2</DatabaseName>
    <DatabaseServer>sample string 5</DatabaseServer>
    <IndexingUserId>7</IndexingUserId>
    <Name>sample string 1</Name>
  </VaultProperties>
</ArrayOfVaultProperties>
Remarks
This operation can return an array of VaultProperties objects. See the Response samples.
See Also
Configuration 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/configuration/vaults?vaultName={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) 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.24