All Classes and Interfaces
Class
Description
Response Model for calls to the Document and Binder User Action endpoints:
Response Model for calls to the Document and Binder User Action endpoints:
Model for the following API calls responses:
Model for the following API calls responses:
Model for the following API calls responses:
Model for the following API calls responses:
Authenticate to Vault using standard username/password, OAuth,
or Salesforce delegated authentication.
Model for the following API calls responses:
Model for the Binder meta-data, which is an array
of nodes (sections) with parent/child relationships.
Retrieve document entry criteria.
Response model for the following API calls:
Response model for the following API calls:
Model for Retrieve Binder Export Results
GET /api/{version}/objects/binders/batch/actions/export/{jobid}/results
GET /api/{version}/objects/binders/batch/actions/export/{jobid}/results
Binder Requests
Model for the binder response
Model for responses to bulk Document Role Requests
TODO
Model for responses to single Document Role Update and Delete requests
TODO
Binder Role Requests
Enum for User or Group request on single binder remove endpoint
Model for responses to Binder Role GET requests
TODO: add endpoints
Model for the binder section response, needed to handle:
1.
1.
Model for the BinderTemplate request and responses.
Model for the Template responses
Model for the following API calls responses:
Model for the Template responses
The Binder Template APIs retrieve information about Binder Templates
Model for the Binder Template responses
The Bulk Active Workflow APIs retrieve information about actions and action details and to execute actions.
Response model for the following API calls:
Response model for the following API calls:
Bulk Translation Requests
Export Bulk Translation File
Import Bulk Translation File
Retrieve Import Bulk Translation File Job Summary
Retrieve Import Bulk Translation File Job Errors
Enum MESSAGE_TYPE represents the message types to import/export.
Model for the following API calls responses:
Model for the following API calls responses:
Model for the Client Code Distribution object.
Response model for the Component Content Files
Response model for the Component Definition Query
Model for the metadata component records
Model for the metadata component types
Configuration Migration
Optional: To show component level details only, set to none.
Optional: Output report as either an Excel (XSLX) or Excel_Macro_Enabled (XLSM) file.
Optional: To include all configuration values, set this to complete.
Model for the following API calls responses:
Model for the following API calls responses:
Model for the following API calls responses:
Direct Data Requests
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
Model for responses to Initiate Delegated Session API:
Model for responses to Retrieve Delegations API:
Direct Data Requests
Retrieve Available Direct Data Files
Download Direct Data File
Enum ExtractType represents the types of extracts.
Response model for the following API calls:
Model for the following API calls responses:
Model for the Document Data
Retrieve document entry criteria.
Response model for the following API calls:
Response model for the following API calls:
Model for Document Annotation Read Data
Model for the document annotation import response
Model for the document annotation bulk responses
Model for the delete document annotations response
Model for the document annotation import response
Model for the document annotation response
Model for document annotation read response
Model for the document annotation response
Model for Document Annotation Reply Read Data
Model for document annotation reply read response
Document Annotation Requests
Enum AnnotationType represents the valid annotation types.
Enum PlacemarkType represents the valid placemark types.
Enum ReferenceType represents the valid reference types.
Model for Document Annotation Read Data
Model for the document annotation response
Model for the Document attachment data
Model for the document response
Document Attachment requests
Model for the document response
Model for the following API calls responses:
Model for document create API response
Model for the document classification response
Model for the Undo Collaborative Authoring Checkout response:
DELETE /api/{version}/objects/documents/batch/lock
DELETE /api/{version}/objects/documents/batch/lock
Model for document deletions API response
Document Events
Model for the following API calls responses:
Model for the following API calls responses:
Model for the following API calls responses:
Model for document export API response
Model for the document field response
Model for lifecycle Role Assignment Rules Response API
Document Lifecycle requests
Model for the Document Lifecycle Role Assignment response
Model for lifecycle Role Assignment Rules Response API
Response model for the following API calls:
Model for the Document/Binder relationship, used in:
- response of the retrieve/get
- inputs to create a Document/Binder relationship
- response of the retrieve/get
- inputs to create a Document/Binder relationship
Model for the Document Relationship Bulk responses
Model for the following API calls responses:
Document Relationship Requests
Model for the Document/Binder relationship response endpoints:
POST /api/{version}/objects/documents/{document_id}/versions/{major_version_number_v}/{minor_version_number_v}/relationships
DELETE /api/{version}/objects/documents/{document_id}/versions/{major_version_number__v}/{minor_version_number__v}/relationships/{relationship_id}
POST /api/{version}/objects/documents/{document_id}/versions/{major_version_number_v}/{minor_version_number_v}/relationships
DELETE /api/{version}/objects/documents/{document_id}/versions/{major_version_number__v}/{minor_version_number__v}/relationships/{relationship_id}
Model for the Document/Binder relationship response endpoints:
GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships
GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
GET /api/{version}/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships
GET /api/{version}/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships
GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
GET /api/{version}/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships
GET /api/{version}/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
Model for the following API calls responses:
Document Rendition requests
Model for the following API calls responses:
Document Requests
CRUD operations (single and bulk)
Create from Template
Placeholders
Versions
Locks
Reclassify
Document Meta-Data
Document Types
Create document from latestcontent or uploadedcontent
Crosslink binding rules enum for doc field picklist source_binding_rule__v
Download option for Document Token
Retrieve all document named filter
Retrieve all document scope
Retrieve all document versions scope
Documents or Binders request type for document requests
Model for the document response
Model for the Document attachment data in Retrieve Document Responses
Model for responses to bulk Document Role Requests
TODO
Model for responses to single Document Role Update and Delete requests
TODO
Model for Document Role Check for Document Change Control response
Document Role Requests
Enum for User or Group request on single document remove endpoint
Model for responses to Document Role GET requests
TODO: add endpoints
Model for the following API calls responses:
Document Events
Model for all documents API Response
Model for the document subtype response
Model for the Document Template request and responses.
Model for the Template responses
Model for the following API calls responses:
Document Template Requests
Model for the document template response
Model for the document templates response
Response model for the following API calls:
Model for the document type response
Model for the all document types response
Response model for the following API calls:
Model for the following API calls responses:
For each control, the following data may be returned:
The API allows you to retrieve, manage, and initiate document
workflows.
Model for the following API calls responses:
Model for the following API calls responses:
Retrieve Domain specific information
Model for the following API calls responses:
Model for the following API calls responses:
Response model for an EDL Matched Document Add and Remove Response
Expected Document Lists (EDLs) help you to measure the completeness of projects.
The tree object types available for selection
Response model for an EDL API response
Model for email notifications API Response
Response Model for calls to the Document and Binder User Action endpoints:
Response model for the following API calls:
File Staging Requests
List Items at a Path
Download Item Content
Create Folder or File
Update Folder or File
Update File or Folder
Resumable Uploads
Enum Kind represents the kind of item to create.
Enum ResultsFormat represents the format that the results can be in
Option(s): CSV
Retrieve Domain specific information
Model for the following API calls responses:
Model for the following API calls responses:
HTTP request class, whether to the Vault API or other servers/APIs.
Handler for streaming a binary file in a multi-part
request.
Options for processing the HTTP response
Handler class sending requests using an Input Stream
HTTP response class, instantiated via the HttpRequestConnector response.
Model for the following API calls responses:
Response model for the following API calls:
Response model for the API Job History response
Response model for the API Job Monitor response
Job - Retrieve Job Status Requests
Response model for the API Job Status response
Response model for the API Job Task response
Vault Loader Requests
Model for the following API calls responses:
Model for the Vault Loader entity, since Vault Loader
handles multiple object/document entities per request.
Model for the following API calls responses:
The Audit APIs retrieve information about audits and audit types
Enum for the various audit trail formats
JSON or CSV Result Types
log_format for the api_usage request
Response model for the following API calls:
Response model for the following API calls:
Response model for the following API calls:
Response model for the following API calls:
Response model for the following API calls:
Response model for the following API call:
Response model for the following API calls:
Response model for the following API calls:
Response model for the following API calls:
Response model for the following API calls:
MetaData Requests
Model for the Attachment attachment metadata
Model for the following API calls responses:
Object Lifecycle and Workflow requests
Retrieve Multi-Record Workflow Details
Model for the following API calls responses:
Retrieve Multi-Record Workflows
Model for the Object Record data
Model for the following API calls responses for the Object Workflow Action
operations:
Model for the following API calls responses:
Object Record Attachment Field requests
Object Record Attachments requests
Model for the following API calls responses:
Model for the following API calls responses for the Object Record
CUD operations:
Model for the following API calls responses for the Object Record CRUD
operations:
Model for Deleted Object Records recycle bin endpoint:
Model for the following API calls responses:
Model for the following API calls responses:
Object Record Requests
CRUD operations (single and bulk)
Object Types
Object Roles
Cascade Deletes
Deep Copy
Other Object Record requests
Model for the following API calls responses for the Object Record CRUD
operations:
Model for the Object Record Role API responses:
Model for the Object Record Role API responses:
Model for the Object Record data
Model for the Object Record Type or Object describe API responses:
Model for the Object Record Type or Object describe API responses:
Model for the following API calls responses for the Object Workflow Action Details
operations:
Model for the following API calls responses for the Object Workflow Action
operations:
Model for the following API calls responses for the Object workflow
operations:
Model for the following API calls responses for the Object Workflow Task Action Details
operations:
Model for the following API calls responses for the Object WorkflowTask
operations:
Model for the following API calls responses:
Model for Package data
Model for Package Steps data
Picklist requests, including retrieval of Picklist meta-data
Model for the following API calls
Model for the following API calls
GET /api/{version}/objects/picklists/{picklist_name}
GET /api/{version}/objects/picklists/{picklist_name}
THE VQL CLASS TO END ALL VQL CLASSES
Download option for Document Token
Model for VQL query API calls
Response model for the following API calls:
Model for User data
Response Model for calls to the Document and Binder Single Role assign endpoints:
Response Model for calls to the Document and Binder Single Role assign endpoints:
Response Model for calls to the Document and Binder Role Retrieve endpoints:
Sandbox Vaults
The type of release.
The sandbox sizes.
The source to refresh the sandbox from.
Managing Vault Java SDK Code
Response model for the following API calls:
Model for response to requests to the Retrieve Security Policies endpoint
All Security Policy requests
Model for response to requests to the Retrieve Security Policy endpoint
Model for the following API calls responses:
Model for the BinderTemplate and DocumentTemplate Metadata
Model for User data
Model for User metadata
Users
Response model for the following API calls:
Base class for all Vault integration calls where a Vault session is established via:
1.
1.
Type of Authentication with the Vault API
Abstract class that is extended by classes that represent nested objects within an API response.
Model for the Vault Object metadata
Model for the Vault Object Field metadata
Class for performing HTTP requests to the Vault API.
Base Vault API response message