A Practical Guide to the SOLIDWORKS PDM API in 2026

The SOLIDWORKS PDM API is one of the most capable developer tools in the SOLIDWORKS ecosystem. It is built as a Windows COM object library. This architecture provides very deep access to the vault, workflows, variables, and the entire PDM client environment.

Many developers expect a modern HTTP interface similar to typical cloud APIs. The PDM API works differently. It is stateful, local, and tightly integrated with the Windows process that runs the PDM client.

A good place to start with the SOLIDWORKS PDM API is the official documentation. Most API calls have examples in C#, VB.NET and VBA.

A COM Object Model, Not a REST API

Since the PDM API is COM-based, your application (if it is a .NET application) interacts with DLLs that are registered in Windows:

From the context of VBA macros, the references are slightly different. When you install the PDM client, a reference called PDMWorks Enterprise XXXX Type Library is installed for you:

There are no HTTP requests, no token-based authentication, no JSON data formats, and no web callbacks. You communicate directly with PDM using COM interfaces such as:

IEdmVault5
IEdmFile5
IEdmFolder5

This gives developers immediate, high-performance access to metadata, folders, variables, references, and workflow information. Because the calls run through the local PDM client, they are fast, and add-ins can respond to vault events such as check-in, state change, add file, add folder or data card interactions.

Which Programming Languages Work With the SOLIDWORKS PDM API

Any language that supports COM interop can be used. The most common today are:

• VBA inside SOLIDWORKS
• .NET:
  • VB.NET
  • C#
• C++
• PowerShell through COM interop

Python can also be used through a COM bridge such as pywin32 (win32com).

Simple VBA Macro to Log Into a Vault

Below is a simple VBA example that connects to a PDM Professional vault. This can be used inside a SOLIDWORKS macro or Excel macro.

Dim vault As EdmVault5
Set vault = New EdmVault5

vault.Login "username", "password", "MyVaultName"
If vault.IsLoggedIn Then
    MsgBox "Logged into the vault"
End If

This is the most basic example, but it shows how COM objects are created and used. In production, use LoginAuto so the macro signs in with the current Windows user instead of a stored password.

PDM Convert Task

PDM ships with the SOLIDWORKS Task Add-in. This add-in can be used to create tasks (scripts that run on the user’s machine or delegated to other computers on the network). These tasks have scripting pages where administrators can add/edit the VBA logic of the task.

These types of scripts are commonly used in PDM tasks that generate PDF, DXF, or STEP documents.

Developing With C# in .NET

Most modern PDM development is done in C#. To use the PDM API, reference the assemblies mentioned above. A simple C# example to log into a vault looks like this:

IEdmVault5 vault = new EdmVault5();
vault.Login("username", "password", "MyVaultName");

if (vault.IsLoggedIn)
{
    Console.WriteLine("Connected to the vault");
}

From there, developers typically work with interfaces like:

IEdmFolder5
IEdmFile5
IEdmBatchGet
IEdmBatchUpdate
IEdmEnumeratorVariable5

These provide almost complete access to files, references, variables, and metadata.

Types of Applications You Can Build

Developers use the PDM API to create many types of solutions. The most common categories are shown below.

PDM add-ins
Runs directly inside the PDM client. Best for deep automations like revision control logic, approval logic, or multi-file processing. A great example of this is our Folder Columns Manager add-in.
PDM Tasks
Automate file conversion, data extraction, printing, publishing, or scripted actions. Tasks run inside a controlled environment and support COM, .NET, and native add-ins. PDMPublisher, a Blue Byte Systems product, is another example.
Desktop Utilities
Standalone EXE tools that use IEdmVault5 to log in and perform batch actions such as metadata cleanup or migration. Check out PDMShell, our command line and workflow automation tool for SOLIDWORKS PDM.

Learn the PDM API With Blue Byte Systems

If you want to learn the PDM API quickly, our SOLIDWORKS PDM API courses on Udemy take you from your first macro to add-ins, tasks, workflow hooks, batch tools and event-driven automation, with live examples from real vaults. For private team training, email amen@bluebyte.biz.

Get our free 50 PDM API Tips and Tricks eBook

Name Layout e-mail

Name *

Professional e-mail *

Send me the eBook