Hide Table of Contents
PDM Pro Web API Help
Getting Started

Glossary Item Box

In order to use the operations in the SOLIDWORKS PDM Professional Web API, you must first install:.

  • SOLIDWORKS PDM Professional

    Read the Installation Guide.pdf and Administration Guide.pdf, both delivered with your installation in c:\Program Files\SOLIDWORKS PDM\Lang\GB.


    Read Installing SOLIDWORKS PDM > Installing SOLIDWORKS PDM Web API Server (For SOLIDWORKS PDM Professional Only) topic in the Installation Guide.pdf delivered with your installation.
  • Microsoft Visual Studio

    Use a .NET project template to create, for example, a C# Console App (.NET Core) or an ASP.NET Web Application (.NET Framework).

To administer your SOLIDWORKS PDM Professional Web API Server, read the Administering API Web Servers (For SOLIDWORKS PDM Professional only) topic in the Administration Guide.pdf delivered with your installation.

The SOLIDWORKS PDM Professional Web API is an extension of Microsoft's ASP.NET Web API which is a framework that allows you to create Representational State Transfer (REST) applications on the .NET Framework.

If you are not familiar with REST, then please Google:

  • Representational state transfer (REST) (Wikipedia)
  • ASP.NET REST APIs with .NET and C# (Microsoft)

Hypertext Transfer Protocol (HTTP) enables communication between clients and servers through a request-response protocol. If you are not familiar with HTTP, then please Google:

  • HTTP Methods (www.w3schools.com)

Your web service application can authenticate logged-in users and set up JSON Web Tokens (JWT) Bearer tokens to securely authorize and restrict API access. Read about the importance of API Security.

To use the API Web Service to authenticate users, authorize access, and use the GET and POST HTTP methods, follow the Example in api/{vaultName}/authenticate.

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

Subject:   Feedback on Help Topics
Page:   Getting Started
*   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:


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

Web Help Content Version: API Help (English only) 2022 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.