Sunday, March 30, 2014

Autodesk Vault Programmer's Cookbook

Introduction


When administrator starts working by himself with Autodesk Vault, he runs into quite unusual client-server logic. For programmers it's even more hard to understand how API really works. Autodesk, no offense.

But after a little time later all becomes much clear and easy. Remembering those days, I tried to comprehend Vault, at now  I'd like to make easy way for others to start working with Vault.


I beg your pardon, but I'll be using PowerShell language mainly, for some reasons:

  1. This is .Net language, so code could be easy translated to any other .NET language: C#, C++ VB.NET, JScript .NET, etc., or even one code could be embedded to other.
  2. The code is extremely short - you can get very illustrative wonderful program in just several lines of code.
  3. PS is interpreted language, you just store it in text and can easy change to create fork.
  4. PS is command line language and you can build object conveyors - this benefits could be useful in administration.
All code available on GitHub.
So, let's start! Approximate TOC you can see below. Links to articles will be continuously updated.
Table of content
  1. Autodesk Vault API basics
    1. API structure
    2. PowerShell basics
    3. Objects of Vault
    4. Methods of Vault API services
  2. Login
    1. Login
    2. Logout
    3. WindowsAuthentication
    4. Read-only access
  3. Groups
    1. Get
    2. Add
    3. Change
    4. Update group information
  4. Users
    1. Retreiving info 
    2. Retreiving roles and permissions info
    3. Adding users
    4. Changing users
    5. Updating users info
  5. Files
    1. Get
    2. Create
    3. Change
    4. Remove
  6. Folders
    1. Get
    2. Create
    3. Change
    4. Remove
  7. Items
    1. Get
    2. Create
    3. Change
    4. Remove
  8. Change orders
    1. Get
    2. Create
    3. Change
    4. Remove
  9. Job
    1. Create job
    2. Maintain job
    3. Handle job
    4. Remove job
  10. BOM
    1. Get
    2. Create
    3. Change
    4. Remove
  11. Lifecycle
    1. Get
    2. Create
    3. Change
    4. Remove
  12. Property
    1. Get
    2. Create
    3. Change
    4. Remove
  13. Revision
    1. Get
    2. Create
    3. Change
    4. Remove
  14. Category
    1. Get
    2. Create
    3. Change
    4. Remove
  15. Custom objects
    1. Get
    2. Create
    3. Change
    4. Remove
Feel free leaving comments and suggestions!