API Basics
The following terms are used throughout this documentation:
| Term | Definition |
|---|---|
| Entity | An entity in Vault is an object that can have behaviors applied to it. For example, files, items, or change orders. |
| File | A file is a document or model that is stored in the Vault. |
| File Version | A file version is a specific iteration of a file. Each file has one or more versions. |
| Item | Items refer to what a company manages, assembles, sells, and manufactures. An item is identified by its item number or part number. |
| Item Version | An item version is a specific iteration of an item. Each item has one or more versions. |
| Bills of Materials (BOMs) | A Bill of Materials (BOM) is a summary of items needed to manufacture a part or product. |
| Change Order | Change orders are a component of the change management process that describe why, how, and when changes are made to a design. |
| Job | A job is a task submitted to the Vault server for processing. Users can add jobs to a queue for automated actions like creating visualization files. The API allows for submitting and deleting jobs within this queue. |
| Link | In Vault, a link is an object in a folder that points to another entity in another location. Similar to a Windows shortcut, a link does not contain the entity itself. |