Getting Started with Autodesk Vault Data API (REST API) – A Modern Approach to Vault Integration
Autodesk has introduced the Vault Data API, a modern REST-based API that enables developers to access and manage Autodesk Vault data without relying on the traditional .NET SDK or SOAP Web Services.
The Vault Data API is part of Autodesk Platform Services (APS) and represents the future direction for Vault integrations, making it easier to build cloud-connected applications, web applications, and cross-platform services.
What is the Vault Data API?
The Vault Data API is a RESTful API that allows applications to interact with Vault using standard HTTP requests.
Instead of installing the Vault SDK and referencing numerous DLLs, developers can now communicate with Vault using simple REST calls over HTTPS.
Typical operations include:
- Searching Vault data
- Retrieving files and folders
- Working with Items
- Managing Change Orders
- Job processing
- Lifecycle operations
- Property retrieval
- User session management
- Account administration
Because it is REST-based, applications written in virtually any programming language can consume the API, including:
- C#
- Java
- Python
- JavaScript
- Node.js
- Go
- PHP
- PowerShell
The API is designed to reduce development complexity while enabling easier integration with enterprise systems such as ERP, MES, PLM, CRM, Power BI, and cloud applications.
Why REST APIs?
Traditional Vault integrations required:
- Vault SDK
- SOAP Web Services
- Windows-specific development
- Numerous DLL references
- Version compatibility management
REST APIs simplify this considerably.
Benefits include:
- Platform independent
- Language independent
- HTTP/HTTPS based
- JSON payloads
- Easy testing with Postman
- Cloud friendly
- Microservice ready
Authentication
The Vault Data API uses Autodesk Platform Services OAuth authentication.
Supported authentication includes:
- 3-legged OAuth (user authentication)
- Secure token-based access
Applications first obtain an APS access token and then use that token when calling Vault Data API endpoints.
Typical Workflow
What Can You Do?
Some common scenarios include:
File Operations
- Search files
- Download files
- Upload files
- Retrieve versions
- Retrieve metadata
Folder Operations
- Browse folders
- Create folders
- Retrieve folder hierarchy
Item Management
- Retrieve Items
- Update Items
- Search Items
Change Orders
- Retrieve change orders
- Update lifecycle information
Property Management
Retrieve:
- System properties
- Custom properties
- Category information
- Lifecycle state
Job Processing
Automate:
- PDF creation
- DWF generation
- Synchronization jobs
- External workflows
Integration Possibilities
The Vault Data API enables integration with:
- ERP systems
- MES solutions
- Power BI
- Manufacturing dashboards
- Custom web portals
- Mobile applications
- Azure Functions
- AWS Lambda
- Power Automate
- Cloud microservices
Code Samples
Autodesk provides sample applications demonstrating:
- .NET Desktop
- Node.js
- Power BI Connector
- Viewer integration
- Property retrieval
These samples provide a strong starting point for developers building new integrations.
Key Points
- Existing custom applications do not need to be rewritten. Legacy SDK-based solutions remain supported.
- New projects should evaluate the Vault Data API first, especially if they target web, cloud, or cross-platform environments.
- Feature parity is still evolving. Not every capability available in the Vault SDK or SOAP APIs is currently exposed through the Vault Data API.
- Autodesk is continuously adding new endpoints and capabilities, and developers can expect the REST API to expand over time as part of the APS ecosystem.
When Should You Choose Each API?
Choose the Vault SDK when:
- Building Vault Explorer add-ins
- Developing Inventor Add-ins
- Creating Job Processor extensions
- Accessing functionality that is not yet available in the REST API
Choose the Vault Data API when:
- Building new integrations
- Creating web portals
- Integrating with external enterprise systems
- Developing cross-platform applications
Conclusion
The Autodesk Vault Data API marks a significant step toward modernizing Vault integrations by bringing RESTful, cloud-friendly capabilities to the Autodesk Platform Services ecosystem. While the traditional Vault SDK and SOAP APIs remain fully supported and continue to serve many desktop customization scenarios, the new REST API provides a streamlined path for building scalable, cross-platform, and cloud-connected applications.
For organizations starting new integration projects, the Vault Data API is an excellent choice that aligns with modern software development practices. At the same time, existing SDK-based applications can continue to operate without requiring immediate migration. As Autodesk continues to expand the Vault Data API with additional endpoints and functionality, developers will have even greater flexibility in choosing the right technology for their integration needs.
For more information on this please refer to the link:
Leave a Reply