Vault API (original) (raw)

• Getting Started

  • Prerequisites
  • Endpoint Structure & Versioning
  • Authenticate to Vault API
  • Upload a Document

• Guides

  • Understanding Document & Object Field Metadata
  • Creating Annotations with Vault API
  • Creating & Downloading Documents in Bulk
  • Postman Collection
    * Using the Vault Platform Postman Collection
    * Setting Up Postman & Postman Environments
    * Authenticating to your Vault
    * Sending Requests to Vault API
  • File Staging
    * About File Staging Paths
    * How to Use File Staging for Inputs
    * How to Use File Staging for Extracts
    * How to Connect Legacy Implementations via FTP

• Explanations

  • Session Management
  • Authentication Defaulting

• References

  • Vault API Rate Limits
  • Response Headers
  • Cross-Origin Requests
  • CSV Format Deviations from RFC
  • Reference ID
  • TLS Supported Cipher Suites
  • Client ID
  • Safety JSON Reference

• Run in Postman

• Authentication

  • User Name and Password
  • OAuth 2.0 / OpenID Connect
  • Retrieve API Versions
  • Authentication Type Discovery
  • Session Keep Alive
  • End Session
  • Salesforce Delegated Requests
  • Delegated Access
    * Retrieve Delegations
    * Initiate Delegated Session

• Direct Data

  • Retrieve Available Direct Data Files
  • Download Direct Data File

• Vault Query Language (VQL)

  • Submitting a Query

• Metadata Definition Language (MDL)

  • Execute MDL Script
  • Asynchronous MDL Requests
    * Execute MDL Script Asynchronously
    * Retrieve Asynchronous MDL Script Results
    * Cancel Raw Object Deployment
  • Retrieve All Component Metadata
  • Retrieve Component Type Metadata
  • Retrieve Component Records
    * Retrieve Component Record Collection
    * Retrieve Component Record (XML/JSON)
    * Retrieve Component Record (MDL)
  • Components with Content
    * Upload Content File
    * Retrieve Content File

• Documents

  • Retrieve Document Fields
    * Retrieve All Document Fields
    * Retrieve Common Document Fields
  • Retrieve Document Types
    * Retrieve All Document Types
    * Retrieve Document Type
    * Retrieve Document Subtype
    * Retrieve Document Classification
  • Retrieve Documents
    * Retrieve Document
    * Retrieve Document Versions
    * Retrieve Document Version
    * Retrieve Document Version Text
    * Download Document File
    * Download Document Version File
    * Download Document Version Thumbnail File
  • Create Documents
    * Create Single Document
    * Create Multiple Documents
  • Update Documents
    * Update Single Document
    * Update Multiple Documents
    * Reclassify Single Document
    * Reclassify Multiple Documents
    * Update Document Version
    * Create Multiple Document Versions
    * Create Single Document Version
  • Delete Documents
    * Delete Single Document
    * Delete Multiple Documents
    * Delete Single Document Version
    * Delete Multiple Document Versions
    * Retrieve Deleted Document IDs
  • Document Locks
    * Retrieve Document Lock Metadata
    * Create Document Lock
    * Retrieve Document Lock
    * Delete Document Lock
    * Undo Collaborative Authoring Checkout
  • Document Renditions
    * Retrieve Document Renditions
    * Retrieve Document Version Renditions
    * Download Document Rendition File
    * Download Document Version Rendition File
    * Add Multiple Document Renditions
    * Add Single Document Rendition
    * Upload Document Version Rendition
    * Update Multiple Document Renditions
    * Replace Document Rendition
    * Replace Document Version Rendition
    * Delete Multiple Document Renditions
    * Delete Single Document Rendition
    * Delete Document Version Rendition
  • Document Attachments
    * Determine if a Document has Attachments
    * Retrieve Document Attachments
    * Retrieve Document Version Attachments
    * Retrieve Document Attachment Versions
    * Retrieve Document Version Attachment Versions
    * Retrieve Document Version Attachment Version Metadata
    * Retrieve Document Attachment Metadata
    * Retrieve Document Attachment Version Metadata
    * Retrieve Deleted Document Attachments
    * Download Document Attachment
    * Download Document Attachment Version
    * Download Document Version Attachment Version
    * Download All Document Attachments
    * Download All Document Version Attachments
    * Delete Single Document Attachment
    * Delete Single Document Attachment Version
    * Delete Multiple Document Attachments
    * Create Document Attachment
    * Create Multiple Document Attachments
    * Restore Document Attachment Version
    * Update Document Attachment Description
    * Update Multiple Document Attachment Descriptions
  • Document Annotations
    * Retrieve Annotation Type Metadata
    * Retrieve Annotation Placemark Type Metadata
    * Retrieve Annotation Reference Type Metadata
    * Create Multiple Annotations
    * Add Annotation Replies
    * Update Annotations
    * Read Annotations by Document Version and Type
    * Read Annotations by ID
    * Read Replies of Parent Annotation
    * Delete Annotations
    * Export Document Annotations to PDF
    * Export Document Version Annotations to PDF
    * Import Document Annotations from PDF
    * Import Document Version Annotations from PDF
    * Retrieve Video Annotations
  • Document Relationships
    * Retrieve Document Type Relationships
    * Retrieve Document Relationships
    * Create Single Document Relationship
    * Create Multiple Document Relationships
    * Retrieve Document Relationship
    * Delete Single Document Relationship
    * Delete Multiple Document Relationships
  • Export Documents
    * Export Documents
    * Export Document Versions
    * Retrieve Document Export Results
  • Document Events
    * Retrieve Document Event Types and Subtypes
    * Retrieve Document Event Subtype Metadata
    * Create Document Event
    * Retrieve Document Events
  • Document Templates
    * Retrieve Document Template Metadata
    * Retrieve Document Template Collection
    * Retrieve Document Template Attributes
    * Download Document Template File
    * Create Single Document Template
    * Create Multiple Document Templates
    * Update Single Document Template
    * Update Multiple Document Templates
    * Delete Basic Document Template
  • Document Signatures
    * Retrieve Document Signature Metadata
    * Retrieve Archived Document Signature Metadata
  • Document Tokens

• Binders

  • Retrieve Binders
    * Retrieve Binder
    * Retrieve All Binder Versions
    * Retrieve Binder Version
  • Create Binders
    * Create Binder
    * Create Binder from Template
    * Create Binder Version
  • Update Binders
    * Update Binder
    * Reclassify Binder
    * Update Binder Version
    * Refresh Binder Auto-Filing
  • Delete Binders
    * Delete Binder
    * Delete Binder Version
  • Export Binders
    * Export Binder
    * Export Binder Version
    * Export Binder Sections
    * Retrieve Binder Export Results
    * Download Exported Binder Files
  • Binder Relationships
    * Retrieve Binder Relationship
    * Create Binder Relationship
    * Delete Binder Relationship
  • Binder Sections
    * Retrieve Binder Sections
    * Retrieve Binder Version Section
    * Create Binder Section
    * Update Binder Section
    * Delete Binder Section
  • Binder Documents
    * Add Document to Binder
    * Move Document in Binder
    * Remove Document from Binder
  • Binder Templates
    * Retrieve Binder Template Metadata
    * Retrieve Binder Template Node Metadata
    * Retrieve Binder Template Collection
    * Retrieve Binder Template Attributes
    * Retrieve Binder Template Node Attributes
    * Create Binder Template
    * Bulk Create Binder Templates
    * Create Binder Template Node
    * Update Binder Template
    * Bulk Update Binder Templates
    * Replace Binder Template Nodes
    * Delete Binder Template
  • Binding Rules
    * Update Binding Rule
    * Update Binder Section Binding Rule
    * Update Binder Document Binding Rule

• Vault Objects

  • Retrieve Object Metadata
  • Retrieve Object Field Metadata
  • Retrieve Object Collection
  • Retrieve Object Records
  • Retrieve Object Record
  • Create & Upsert Object Records
  • Roll-up Fields
    * Recalculate Roll-up Fields
    * Retrieve Roll-up Field Recalculation Status
  • Update Object Records
  • Delete Object Records
  • Cascade Delete Object Record
  • Retrieve Results of Cascade Delete Job
  • Merge Object Records
    * Initiate Record Merge
    * Retrieve Record Merge Status
    * Retrieve Record Merge Results
    * Download Merge Records Job Log
  • Object Types
    * Retrieve Details from All Object Types
    * Retrieve Details from a Specific Object
    * Change Object Type
  • Object Roles
    * Retrieve Object Record Roles
    * Assign Users & Groups to Roles on Object Records
    * Remove Users & Groups from Roles on Object Records
  • Object Record Attachments
    * Determine if Attachments are Enabled on an Object
    * Retrieve Object Record Attachments
    * Retrieve Object Record Attachment Metadata
    * Retrieve Object Record Attachment Versions
    * Retrieve Object Record Attachment Version Metadata
    * Retrieve Deleted Object Record Attachments
    * Download Object Record Attachment File
    * Download Object Record Attachment Version File
    * Download All Object Record Attachment Files
    * Create Object Record Attachment
    * Create Multiple Object Record Attachments
    * Restore Object Record Attachment Version
    * Update Object Record Attachment Description
    * Update Multiple Object Record Attachment Descriptions
    * Delete Object Record Attachment
    * Delete Multiple Object Record Attachments
    * Delete Object Record Attachment Version
  • Object Page Layouts
    * Retrieve Page Layouts
    * Retrieve Page Layout Metadata
  • Object Attachment Fields
    * Download Attachment Field File
    * Download All Attachment Field Files
    * Export Attachment Field Files
    * Retrieve Attachment Field Files Export Results
    * Download Attachment Field Files Export
    * Update Attachment Field File
  • Deep Copy Object Record
  • Retrieve Results of Deep Copy Job
  • Retrieve Deleted Object Record ID
  • Retrieve Limits on Objects
  • Update Corporate Currency Fields

• Document and Binder Roles

  • Document Roles
    * Retrieve All Document Roles
    * Retrieve Document Role
    * Assign Users & Groups to Roles on a Single Document
    * Assign Users & Groups to Roles on Multiple Documents & Binders
    * Remove Users & Groups from Roles on a Single Document
    * Remove Users & Groups from Roles on Multiple Documents & Binders
  • Binder Roles
    * Retrieve All Binder Roles
    * Retrieve Binder Role
    * Assign Users & Groups to Roles on a Single Binder
    * Remove Users & Groups from Roles on a Single Binder

• Workflows

  • Retrieve Workflows
  • Retrieve Workflow Details
  • Retrieve Workflow Actions
  • Retrieve Workflow Action Details
  • Initiate Workflow Action
  • Workflow Tasks
    * Retrieve Workflow Tasks
    * Retrieve Workflow Task Details
    * Retrieve Workflow Task Actions
    * Retrieve Workflow Task Action Details
    * Accept Multi-item Workflow Task
    * Accept Single Record Workflow Task
    * Undo Workflow Task Acceptance
    * Complete Multi-item Workflow Task
    * Complete Single Record Workflow Task
    * Reassign Multi-item Workflow Task
    * Reassign Single Record Workflow Task
    * Update Workflow Task Due Date
    * Cancel Workflow Task
    * Manage Multi-item Workflow Content
  • Complete Job Step
  • Bulk Active Workflow Actions
    * Retrieve Bulk Workflow Actions
    * Retrieve Bulk Workflow Action Details
    * Initiate Workflow Actions on Multiple Workflows

• Document Lifecycle and Workflows

  • Document User Actions
    * Retrieve Document User Actions
    * Retrieve User Actions on Multiple Documents
    * Retrieve Document Entry Criteria
    * Initiate Document User Action
    * Download Controlled Copy Job Results
    * Initiate Bulk Document User Actions
  • Binder User Actions
    * Retrieve Binder User Actions
    * Retrieve User Actions on Multiple Binders
    * Retrieve Binder Entry Criteria
    * Initiate Binder User Action
    * Initiate Bulk Binder User Actions
  • Lifecycle Role Assignment Rules
    * Retrieve Lifecycle Role Assignment Rules (Default & Override)
    * Create Lifecycle Role Assignment Override Rules
    * Update Lifecycle Role Assignment Rules (Default & Override)
    * Delete Lifecycle Role Assignment Override Rules
  • Document Workflows
    * Retrieve All Document Workflows
    * Retrieve Document Workflow Details
    * Initiate Document Workflow

• Object Lifecycle and Workflows

  • Object Record User Actions
    * Retrieve Object Record User Actions
    * Retrieve Object User Action Details
    * Initiate Object Action on a Single Record
    * Initiate Object Action on Multiple Records
  • Multi-Record Workflows
    * Retrieve All Multi-Record Workflows
    * Retrieve Multi-Record Workflow Details
    * Initiate Multi-Record Workflow

• Users

  • Retrieve User Metadata
  • Retrieve All Users
  • Retrieve User
  • Create Users
    * Create Single User
    * Create Multiple Users
  • Update Users
    * Update Single User
    * Update My User
    * Update Multiple Users
  • Disable User
  • Change My Password
  • Update Vault Membership
  • Retrieve Application License Usage
  • Retrieve User Permissions
  • Retrieve My User Permissions
  • Validate Session User

• SCIM

  • Discovery Endpoints
    * Retrieve SCIM Provider
    * Retrieve All SCIM Schema Information
    * Retrieve Single SCIM Schema Information
    * Retrieve All SCIM Resource Types
    * Retrieve Single SCIM Resource Type
  • Users
    * Retrieve All Users with SCIM
    * Retrieve Single User with SCIM
    * Retrieve Current User with SCIM
    * Update Current User with SCIM
    * Create User with SCIM
    * Update User with SCIM
    * Retrieve SCIM Resources
    * Retrieve Single SCIM Resource

• Groups

  • Retrieve Group Metadata
  • Retrieve All Groups
  • Retrieve Auto Managed Groups
  • Retrieve Group
  • Create Group
  • Update Group
  • Delete Group

• Picklists

  • Retrieve All Picklists
  • Retrieve Picklist Values
  • Create Picklist Values
  • Update Picklist Value Label
  • Update Picklist Value
  • Inactivate Picklist Value

• Expected Document Lists

  • Create a Placeholder from an EDL Item
  • Retrieve All Root Nodes
  • Retrieve Specific Root Nodes
  • Retrieve a Node's Children
  • Update Node Order
  • Add EDL Matched Documents
  • Remove EDL Matched Documents

• Security Policies

  • Retrieve Security Policy Metadata
  • Retrieve All Security Policies
  • Retrieve Security Policy

• Domain Information

  • Retrieve Domain Information
  • Retrieve Domains

• Configuration Migration

  • Export Package
  • Import Package
  • Deploy Package
  • Retrieve Package Deploy Results
  • Retrieve Outbound Package Dependencies
  • Component Definition Query
  • Vault Compare
  • Vault Configuration Report
  • Validate Package
  • Validate Inbound Package
  • Enable Configuration Mode
  • Disable Configuration Mode

• Sandbox Vaults

  • Retrieve Sandboxes
  • Retrieve Sandbox Details by ID
  • Recheck Sandbox Usage Limit
  • Change Sandbox Size
  • Set Sandbox Entitlements
  • Create or Refresh Sandbox
  • Refresh Sandbox from Snapshot
  • Delete Sandbox
  • Sandbox Snapshots
    * Create Sandbox Snapshot
    * Retrieve Sandbox Snapshots
    * Delete Sandbox Snapshot
    * Update Sandbox Snapshot
    * Upgrade Sandbox Snapshot
  • Pre-Production Vaults
    * Build Production Vault
    * Promote to Production

• Logs

  • Audit
    * Retrieve Audit Types
    * Retrieve Audit Metadata
    * Retrieve Audit Details
  • Audit History
    * Retrieve Complete Audit History for a Single Document
    * Retrieve Complete Audit History for a Single Object Record
  • SDK Debug Log
    * Retrieve All Debug Logs
    * Retrieve Single Debug Log
    * Download Debug Log Files
    * Create Debug Log
    * Reset Debug Log
    * Delete Debug Log
  • SDK Request Profiler
    * Retrieve All Profiling Sessions
    * Retrieve Profiling Session
    * Create Profiling Session
    * End Profiling Session
    * Delete Profiling Session
    * Download Profiling Session Results
  • Retrieve Email Notification Histories
  • Download Daily API Usage
  • Download SDK Runtime Log
  • Download Workflow Activity Log

• File Staging

  • List Items at a Path
  • Download Item Content
  • Create Folder or File
  • Update Folder or File
  • Delete File or Folder
  • Resumable Upload Sessions
    * Create Resumable Upload Session
    * Upload to a Session
    * Commit Upload Session
    * List Upload Sessions
    * Get Upload Session Details
    * List File Parts Uploaded to Session
    * Abort Upload Session

• Vault Loader

  • Multi-File Extract
    * Extract Data Files
    * Retrieve Loader Extract Results
    * Retrieve Loader Extract Renditions Results
    * Retrieve Loader Extract Text Results
  • Multi-File Load
    * Load Data Objects
    * Retrieve Load Success Log Results
    * Retrieve Load Failure Log Results

• Bulk Translation

  • Export Bulk Translation File
  • Import Bulk Translation Files
  • Retrieve Import Bulk Translation File Job Summary
  • Retrieve Import Bulk Translation File Job Errors
  • Export Label Set

• Jobs

  • Retrieve Job Status
  • Retrieve SDK Job Tasks
  • Retrieve Job Histories
  • Retrieve Job Monitors
  • Start Job
  • Cancel Job

• Managing Vault Java SDK

  • Retrieve Single Source Code File
  • Enable Vault Extension
  • Disable Vault Extension
  • Add or Replace Single Source Code File
  • Delete Single Source Code File
  • Validate Imported Package
  • Retrieve Signing Certificate
  • Queues
    * Retrieve All Queues
    * Retrieve Queue Status
    * Disable Delivery
    * Enable Delivery
    * Reset Queue

• Custom Pages

  • Retrieve All Client Code Distribution Metadata
  • Retrieve Single Client Code Distribution Metadata
  • Download Single Client Code Distribution
  • Add or Replace Single Client Code Distribution
  • Delete Single Client Code Distribution

• Errors

  • Error Types

Vault API

Integrate your application with Vault

Vault API allows you to read and write to Vault securely, allowing your application to integrate directly with Vault.