Reference Guide
REST API Reference
Informational
| Operation | Method + Endpoint |
|---|---|
| Get OpenAPI Specification | GET /openapi-spec.yml |
| Get Server Information | GET /server-info |
| Get All Knowledge Vaults | GET /vaults |
| Get a Knowledge Vault | GET /vaults/{id} |
Accounts
| Operation | Method + Endpoint |
|---|---|
| Get All Groups | GET /groups |
| Get a Group | GET /groups/{id} |
| Get Group Account by Type | GET /groups/{id}/accounts/{authType} |
| Get All Profile Attribute Definitions | GET /profile-attribute-definitions |
| Get a Profile Attribute Definition | GET /profile-attribute-definitions/{id} |
| Get User Roles | GET /roles |
| Get a User Role | GET /roles/{id} |
| Get All Users | GET /users |
| Get a User | GET /users/{id} |
| Get User Accounts | GET /users/{id}/accounts |
| Get a User Account | GET /users/{id}/accounts/{authType} |
Auth
| Operation | Method + Endpoint |
|---|---|
| Create Session with Vault Credentials | POST /sessions |
| Create a Session with Windows Auth | POST /sessions/win-auth |
| Get Current Session | GET /sessions/{id} |
| Delete Current Session | DELETE /sessions/{id} |
Options
| Operation | Method + Endpoint |
|---|---|
| Get System Options | GET /system-options |
| Create a System Option | POST /system-options |
| Get a System Option | GET /system-options/{id} |
| Update a System Option | PATCH /system-options/{id} |
| Delete a System Option | DELETE /system-options/{id} |
| Get All Vault Options | GET /vaults/{vaultId}/vault-options |
| Create a Vault Option | POST /vaults/{vaultId}/vault-options |
| Get a Vault Option | GET /vaults/{vaultId}/vault-options/{id} |
| Update a Vault Option | PATCH /vaults/{vaultId}/vault-options/{id} |
| Delete a Vault Option | DELETE /vaults/{vaultId}/vault-options/{id} |
| Get All External Sync Configs | GET /vaults/{vaultId}/vault-options/ext-sync-configs |
Change Orders
| Operation | Method + Endpoint |
|---|---|
| Get All Change Orders | GET /vaults/{vaultId}/change-orders |
| Get a Change Order | GET /vaults/{vaultId}/change-orders/{id} |
| Get Change Order Files | GET /vaults/{vaultId}/change-orders/{id}/all-related-files |
| Get Change Order Associated Entities | GET /vaults/{vaultId}/change-orders/{id}/associated-entities |
| Get Change Order Comments | GET /vaults/{vaultId}/change-orders/{id}/comments |
| Get Change Order Comment Attachments | GET /vaults/{vaultId}/change-order-comments/{id}/attachments |
Files and Folders
| Operation | Method + Endpoint |
|---|---|
| Get File Versions | GET /vaults/{vaultId}/file-versions |
| Get a File Version | GET /vaults/{vaultId}/file-versions/{id} |
| Generate File Version Download URL | GET /vaults/{vaultId}/file-versions/{id}/signedurl |
| Download File Version Content | GET /vaults/{vaultId}/file-versions/{id}/content |
| Get File Version Content Metadata | HEAD /vaults/{vaultId}/file-versions/{id}/content |
| Get the LMV Root for File Version | GET /vaults/{vaultId}/file-versions/{id}/svf/bubble.json |
| Get Items for File Version | GET /vaults/{vaultId}/file-versions/{id}/item-versions |
| Get Markups for File Version | GET /vaults/{vaultId}/file-versions/{id}/markups |
| Get a Markup for File Version | GET /vaults/{vaultId}/file-versions/{id}/markups/{markupId} |
| Download File Version Thumbnail | GET /vaults/{vaultId}/file-versions/{id}/thumbnail |
| Get Visualization Attachments | GET /vaults/{vaultId}/file-versions/{id}/visualization-attachments |
| Get Child Associations for File Version | GET /vaults/{vaultId}/file-versions/{id}/uses |
| Get Parent Associations for File Version | GET /vaults/{vaultId}/file-versions/{id}/parents |
| Get a File | GET /vaults/{vaultId}/files/{id} |
| Get Change Orders for File | GET /vaults/{vaultId}/files/{id}/change-orders |
| Get Version History for File | GET /vaults/{vaultId}/files/{id}/versions |
| Update File Lifecycle States | POST /vaults/{vaultId}/files:update-states |
| Update File Lifecycle Definitions | POST /vaults/{vaultId}/files:update-lifecycle-definitions |
| Get a Folder | GET /vaults/{vaultId}/folders/{id} |
| Get Folder Contents | GET /vaults/{vaultId}/folders/{id}/contents |
| Get Subfolders | GET /vaults/{vaultId}/folders/{id}/sub-folders |
| Update Multiple Folder Lifecycle States | POST /vaults/{vaultId}/folders:update-states |
| Update Folder Lifecycle Definitions | POST /vaults/{vaultId}/folders:update-lifecycle-definitions |
| Get File Attributes (Beta) | GET /vaults/{vaultId}/files/{id}/attributes |
| Set File Attribute (Beta) | PUT /vaults/{vaultId}/files/{id}/attributes |
| Add File (Beta) | POST /vaults/{vaultId}/files |
| Get Latest Files by Master IDs (Beta) | POST /vaults/{vaultId}/files/latest |
| Check Out File (Beta) | POST /vaults/{vaultId}/files/{id}:checkout |
| Undo File Checkout (Beta) | POST /vaults/{vaultId}/files/{id}:undo-checkout |
| Update File Properties (Beta) | POST /vaults/{vaultId}/files/{id}:update-properties |
| Check In File (Beta) | POST /vaults/{vaultId}/files/{id}:checkin |
| Update File Categories (Beta) | POST /vaults/{vaultId}/files:update-categories |
| Create Folder (Beta) | POST /vaults/{vaultId}/folders |
| Create File Upload (Beta) | POST /vaults/{vaultId}/file-uploads |
| Upload File Content Part (Beta) | PUT /vaults/{vaultId}/file-uploads/{uploadId}/parts/{partIndex} |
| Complete File Upload (Beta) | POST /vaults/{vaultId}/file-uploads/{uploadId}:complete |
Items
| Operation | Method + Endpoint |
|---|---|
| Get Item Versions | GET /vaults/{vaultId}/item-versions |
| Get an Item Version | GET /vaults/{vaultId}/item-versions/{id} |
| Get File Associations for Item Version | GET /vaults/{vaultId}/item-versions/{id}/associated-files |
| Get Child Items for Item Version | GET /vaults/{vaultId}/item-versions/{id}/bill-of-materials |
| Get Parent Items for Item Version | GET /vaults/{vaultId}/item-versions/{id}/parents |
| Get Item Version External Sync Infos | GET /vaults/{vaultId}/item-versions/{id}/ext-sync-infos |
| Get Item Version External Sync Info | GET /vaults/{vaultId}/item-versions/{id}/ext-sync-infos/{infoName} |
| Get Thumbnail for Item Version | GET /vaults/{vaultId}/item-versions/{id}/thumbnail |
| Get All Items | GET /vaults/{vaultId}/items |
| Create Item (Beta) | POST /vaults/{vaultId}/items |
| Get an Item | GET /vaults/{vaultId}/items/{id} |
| Get Change Orders for Item | GET /vaults/{vaultId}/items/{id}/change-orders |
| Get All External Sync Infos for Item | GET /vaults/{vaultId}/items/{id}/ext-sync-infos |
| Get an External Sync Info for Item | GET /vaults/{vaultId}/items/{id}/ext-sync-infos/{infoName} |
| Get Version History for Item | GET /vaults/{vaultId}/items/{id}/versions |
| Update Item Lifecycle States | POST /vaults/{vaultId}/items:update-states |
| Update Item Lifecycle Definitions | POST /vaults/{vaultId}/items:update-lifecycle-definitions |
| Get Item Attributes (Beta) | GET /vaults/{vaultId}/items/{id}/attributes |
| Set Item Attribute (Beta) | PUT /vaults/{vaultId}/items/{id}/attributes |
Jobs
| Operation | Method + Endpoint |
|---|---|
| Create a Job | POST /vaults/{vaultId}/jobs |
| Get Job Queue Status | GET /vaults/{vaultId}/jobs/job-queue-enabled |
| Get a Job | GET /vaults/{vaultId}/jobs/{id} |
Ext Sync Tasks
| Operation | Method + Endpoint |
|---|---|
| Get All External Sync Tasks | GET /vaults/{vaultId}/ext-sync-tasks |
| Create an External Sync Task | POST /vaults/{vaultId}/ext-sync-tasks |
| Get an External Sync Task | GET /vaults/{vaultId}/ext-sync-tasks/{id} |
| Delete an External Sync Task | DELETE /vaults/{vaultId}/ext-sync-tasks/{id} |
| Resubmit an External Sync Task | POST /vaults/{vaultId}/ext-sync-tasks/{id}:resubmit |
| Find External Sync Tasks by Entity IDs | POST /vaults/{vaultId}/ext-sync-tasks:find-by-entity-ids |
| Create External Sync Tasks in Batch | POST /vaults/{vaultId}/ext-sync-tasks:batch-create |
Links
| Operation | Method + Endpoint |
|---|---|
| Get All Links | GET /vaults/{vaultId}/links |
| Get a Link | GET /vaults/{vaultId}/links/{id} |
Property
| Operation | Method + Endpoint |
|---|---|
| Get All Property Definitions | GET /vaults/{vaultId}/property-definitions |
| Get a Property Definition | GET /vaults/{vaultId}/property-definitions/{id} |
Lifecycle
| Operation | Method + Endpoint |
|---|---|
| Get All Lifecycle Definitions | GET /vaults/{vaultId}/lifecycle-definitions |
| Get a Lifecycle Definition | GET /vaults/{vaultId}/lifecycle-definitions/{id} |
| Get Lifecycle States | GET /vaults/{vaultId}/lifecycle-states |
| Get a Lifecycle State | GET /vaults/{vaultId}/lifecycle-states/{id} |
Search
| Operation | Method + Endpoint |
|---|---|
| Basic Search | GET /vaults/{vaultId}/search-results |
| Advanced Search | POST /vaults/{vaultId}:advanced-search |
Category
| Operation | Method + Endpoint |
|---|---|
| Get All Categories (Beta) | GET /vaults/{vaultId}/categories |
| Get Category (Beta) | GET /vaults/{vaultId}/categories/{id} |
Unit of Measure
| Operation | Method + Endpoint |
|---|---|
| Get All Units of Measure (Beta) | GET /vaults/{vaultId}/units-of-measure |
| Get Unit of Measure (Beta) | GET /vaults/{vaultId}/units-of-measure/{id} |
Numbering
| Operation | Method + Endpoint |
|---|---|
| Get All Numbering Schemes (Beta) | GET /vaults/{vaultId}/numbering-schemes |
| Get Numbering Scheme (Beta) | GET /vaults/{vaultId}/numbering-schemes/{id} |