Reference Guide
Quick 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 information by specific 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 an user role | GET /roles/{id} |
Get all users | GET /users |
Get an user | GET /users/{id} |
Get user accounts | GET /users/{id}/accounts |
Get an user account | GET /users/{id}/accounts/{authType} |
Auth
Operation | Method + Endpoint |
---|---|
Create session with Vault credentials | POST /sessions |
Create a session with Windows authentication | 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 |
Creates 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} |
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 signed download URL for a file version | 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 for file version | 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 versions history for file | GET /vaults/{vaultId}/files/{id}/versions |
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 |
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 thumbnail for item version | GET /vaults/{vaultId}/item-versions/{id}/thumbnail |
Get all items | GET /vaults/{vaultId}/items |
Get an item | GET /vaults/{vaultId}/items/{id} |
Get Change Orders for item | GET /vaults/{vaultId}/items/{id}/change-orders |
Get version history for item | GET /vaults/{vaultId}/items/{id}/versions |
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} |
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} |
Search
Operation | Method + Endpoint |
---|---|
Basic search | GET /vaults/{vaultId}/search-results |
Advanced search | POST /vaults/{vaultId}:advanced-search |