Uses of Class
com.veeva.vault.vapil.api.model.response.VaultResponse
Packages that use VaultResponse
Package
Description
Models for Vault API responses
Methods to perform Vault API calls, with each method mapping to a Vault API endpoint
-
Uses of VaultResponse in com.veeva.vault.vapil.api.model.response
Subclasses of VaultResponse in com.veeva.vault.vapil.api.model.responseModifier and TypeClassDescriptionclass
Response Model for calls to the Document and Binder User Action endpoints:class
Response Model for calls to the Document and Binder User Action endpoints:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Retrieve document entry criteria.class
Response model for the following API calls:class
Response model for the following API calls:class
Model for Retrieve Binder Export Results
GET /api/{version}/objects/binders/batch/actions/export/{jobid}/resultsclass
Model for the binder responseclass
Model for responses to bulk Document Role Requests TODOclass
Model for responses to single Document Role Update and Delete requests TODOclass
Model for responses to Binder Role GET requests TODO: add endpointsclass
Model for the binder section response, needed to handle:
1.class
Model for the Template responsesstatic class
class
Model for the following API calls responses:class
Model for the Template responsesstatic class
class
Model for the Binder Template responsesclass
Response model for the following API calls:class
Response model for the following API calls:class
Model for the following API calls responses:class
Model for the following API calls responses:class
class
Response model for the Component Content Filesclass
Response model for the Component Definition Queryclass
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for responses to Initiate Delegated Session API:class
Model for responses to Retrieve Delegations API:class
Response model for the following API calls:class
Model for the following API calls responses:class
Retrieve document entry criteria.class
Response model for the following API calls:class
Response model for the following API calls:class
Model for the document annotation import responseclass
Model for the document annotation bulk responsesclass
Model for the delete document annotations responseclass
Model for the document annotation import responseclass
Model for the document annotation responseclass
Model for document annotation read responseclass
Model for the document annotation responseclass
Model for document annotation reply read responseclass
Model for the document annotation responseclass
Model for the document responseclass
Model for the document responseclass
Model for the following API calls responses:class
Model for document create API responseclass
Model for the document classification responseclass
Model for the Undo Collaborative Authoring Checkout response:
DELETE /api/{version}/objects/documents/batch/lockstatic class
class
Model for document deletions API responseclass
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for document export API responsestatic class
class
Model for the document field responseclass
Model for lifecycle Role Assignment Rules Response APIclass
Model for the Document Lifecycle Role Assignment responseclass
Model for lifecycle Role Assignment Rules Response APIclass
Response model for the following API calls:class
Model for the Document Relationship Bulk responsesclass
Model for the following API calls responses:class
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}class
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}class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the document responseclass
Model for responses to bulk Document Role Requests TODOclass
Model for responses to single Document Role Update and Delete requests TODOclass
Model for Document Role Check for Document Change Control responseclass
Model for responses to Document Role GET requests TODO: add endpointsclass
Model for the following API calls responses:class
Model for all documents API Responseclass
Model for the document subtype responseclass
Model for the Template responsesstatic class
class
Model for the following API calls responses:class
Model for the document template responseclass
Model for the document templates responseclass
Response model for the following API calls:class
Model for the document type responseclass
Model for the all document types responseclass
Response model for the following API calls:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Response model for an EDL Matched Document Add and Remove Responseclass
Response model for an EDL API responseclass
Model for email notifications API Responseclass
Response Model for calls to the Document and Binder User Action endpoints:class
class
class
Response model for the following API calls:class
class
class
class
class
Model for the following API calls responses:class
class
Model for the following API calls responses:class
Model for the following API calls responses:class
Response model for the following API calls:class
Response model for the API Job History responseclass
Response model for the API Job Monitor responseclass
Response model for the API Job Status responseclass
Response model for the API Job Task responseclass
Model for the following API calls responses:class
Model for the following API calls responses:class
Response model for the following API calls:class
Response model for the following API calls:class
Response model for the following API calls:class
Response model for the following API calls:class
Response model for the following API calls:class
class
Response model for the following API call:class
Response model for the following API calls:class
Response model for the following API calls:class
Response model for the following API calls:class
Response model for the following API calls:class
class
class
Model for the following API calls responses:class
Retrieve Multi-Record Workflow Detailsclass
Model for the following API calls responses:class
Retrieve Multi-Record Workflowsclass
Model for the following API calls responses for the Object Workflow Action operations:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses for the Object Record CUD operations:class
Model for the following API calls responses for the Object Record CRUD operations:class
Model for Deleted Object Records recycle bin endpoint:class
Model for the following API calls responses:class
Model for the following API calls responses:class
Model for the following API calls responses for the Object Record CRUD operations:class
Model for the Object Record Role API responses:class
Model for the Object Record Role API responses:class
Model for the Object Record Type or Object describe API responses:static class
class
Model for the Object Record Type or Object describe API responses:class
Model for the following API calls responses for the Object Workflow Action Details operations:class
Model for the following API calls responses for the Object Workflow Action operations:class
Model for the following API calls responses for the Object workflow operations:class
Model for the following API calls responses for the Object Workflow Task Action Details operations:class
Model for the following API calls responses for the Object WorkflowTask operations:class
class
Model for the following API calls responses:class
class
Model for the following API callsclass
Model for the following API calls
GET /api/{version}/objects/picklists/{picklist_name}class
Model for VQL query API callsclass
Response model for the following API calls:class
Response Model for calls to the Document and Binder Single Role assign endpoints:static class
class
Response Model for calls to the Document and Binder Single Role assign endpoints:class
Response Model for calls to the Document and Binder Role Retrieve endpoints:class
class
class
class
class
class
class
class
class
static class
class
class
class
static class
class
class
Response model for the following API calls:class
Model for response to requests to the Retrieve Security Policies endpointclass
Model for response to requests to the Retrieve Security Policy endpointclass
Model for the following API calls responses:class
class
class
class
class
class
Response model for the following API calls:Methods in com.veeva.vault.vapil.api.model.response that return types with arguments of type VaultResponseMethod parameters in com.veeva.vault.vapil.api.model.response with type arguments of type VaultResponseModifier and TypeMethodDescriptionvoid
DocumentLifecycleRoleAssignmentRulesResponse.setData
(List<VaultResponse> data) -
Uses of VaultResponse in com.veeva.vault.vapil.api.request
Methods in com.veeva.vault.vapil.api.request that return VaultResponseModifier and TypeMethodDescriptionFileStagingRequest.abortUploadSession
(String uploadSessionId) Abort Upload SessionDocumentRenditionRequest.addMultipleDocumentRenditions()
Add Multiple Document Renditions
Add document renditions in bulk.DocumentRenditionRequest.addSingleDocumentRendition
(int docId, String renditionType) Add Single Document Rendition
If you need to add more than one document rendition, it is best practice to useDocumentRenditionRequest.addMultipleDocumentRenditions()
MetaDataRequest.cancelRawObjectDeployment
(String objectName) Cancel Raw Object DeploymentUserRequest.changePassword
(int userId, String currentPassword, String newPassword) Change Your PasswordSandboxRequest.changeSandboxSize
(String name, SandboxRequest.SandboxSize sandboxSize) Change Sandbox SizeDocumentEventRequest.createDocumentEvent
(int docId, int majorVersion, int minorVersion, DocumentEvent.Property eventProperties) Create Document EventDocumentRequest.createDocumentLock
(int docId) Create Document LockLogRequest.deleteDebugLog
(String id) Delete Debug LogDocumentRequest.deleteDocumentLock
(int docId) Deleting Document LockDocumentRenditionRequest.deleteDocumentVersionRendition
(int docId, int majorVersion, int minorVersion, String renditionType) Delete Document Version RenditionDocumentRenditionRequest.deleteMultipleDocumentRenditions()
Delete Multiple Document RenditionsLogRequest.deleteProfilingSession
(String sessionName) Delete Profiling SessionSandboxRequest.deleteSandbox
(String name) Delete a sandbox vault.SandboxRequest.deleteSandboxSnapshot
(String apiName) Delete Sandbox SnapshotCustomPagesRequest.deleteSingleClientCodeDistribution
(String distributionName) Delete Single Client Code DistributionDocumentAttachmentRequest.deleteSingleDocumentAttachment
(int docId, int attachmentId) Delete Single Document AttachmentDocumentAttachmentRequest.deleteSingleDocumentAttachmentVersion
(int docId, int attachmentId, int attachmentVersion) Delete Single Document Attachment VersionDocumentRenditionRequest.deleteSingleDocumentRendition
(int docId, String renditionType) Delete Single Document RenditionSDKRequest.deleteSingleSourceCodeFile
(String className) Delete Single Source Code FileConfigurationMigrationRequest.disableConfigurationMode()
Disable Configuration ModeSDKRequest.disableDelivery
(String queueName) Disable DeliveryObjectRecordAttachmentFieldRequest.downloadAllAttachmentFieldFiles
(String objectName, String recordId) Download All Attachment Field FilesDocumentAttachmentRequest.downloadAllDocumentAttachments
(int docId) Download All Document AttachmentsDocumentAttachmentRequest.downloadAllDocumentVersionAttachments
(int docId, int majorVersionNumber, int minorVersionNumber) Download All Document Version AttachmentsObjectRecordAttachmentRequest.downloadAllObjectRecordAttachmentFiles
(String objectName, String recordId) Download All Object Record Attachment FilesObjectRecordAttachmentFieldRequest.downloadAttachmentFieldFile
(String objectName, String recordId, String attachmentFieldName) Download Attachment Field FileDocumentLifecycleRequest.downloadControlledCopyJobResult
(String lifecycleStateAction, int jobId) Download Controlled Copy Job Results.LogRequest.downloadDebugLogFiles
(String id) Download Debug Log FilesDirectDataRequest.downloadDirectDataFile
(String name) Download Direct Data FileDocumentAttachmentRequest.downloadDocumentAttachment
(int docId, int attachmentId) Download Document AttachmentDocumentAttachmentRequest.downloadDocumentAttachmentVersion
(int docId, int attachmentId, int attachVersionId) Download Document Attachment VersionDocumentRequest.downloadDocumentFile
(int docId) Download Document FileDocumentRenditionRequest.downloadDocumentRenditionFile
(int docId, String renditionType) Download Document Rendition FileDocumentRenditionRequest.downloadDocumentRenditionFile
(int docId, String renditionType, Boolean steadyState) Download Document Rendition FileDocumentTemplateRequest.downloadDocumentTemplateFile
(String templateName) Download Document Template FileDocumentAttachmentRequest.downloadDocumentVersionAttachment
(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId) Download Document Version AttachmentDocumentAttachmentRequest.downloadDocumentVersionAttachmentVersion
(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId, int attachVersionId) Download Document Version Attachment VersionDocumentRequest.downloadDocumentVersionFile
(int docId, int majorVersion, int minorVersion) Download Document Version FileDocumentRenditionRequest.downloadDocumentVersionRenditionFile
(int docId, int majorVersion, int minorVersion, String renditionType) Download Document Version Rendition FileDocumentRequest.downloadDocumentVersionThumbnailFile
(int docId, int majorVersion, int minorVersion) Download Document Version Thumbnail FileFileStagingRequest.downloadItemContent
(String item) Download Item ContentObjectRecordAttachmentRequest.downloadObjectRecordAttachmentFile
(String objectName, String recordId, int attachmentId) Download Object Record Attachment FileObjectRecordAttachmentRequest.downloadObjectRecordAttachmentVersionFile
(String objectName, String recordId, int attachmentId, int versionId) Download Object Record Attachment Version FileLogRequest.downloadProfilingSessionResults
(String sessionName) Download Profiling Session ResultsLogRequest.downloadSdkRuntimeLog
(LocalDate logDate) Download SDK Runtime LogCustomPagesRequest.downloadSingleClientCodeDistribution
(String distributionName) Download Single Client Code DistributionConfigurationMigrationRequest.enableConfigurationMode()
Enable Configuration ModeSDKRequest.enableDelivery
(String queueName) Enable DeliveryLogRequest.endProfilingSession
(String sessionName) End Profiling SessionAuthenticationRequest.endSession()
End SessionDocumentAnnotationRequest.exportDocumentAnnotationsToPdf
(int docId) Export Document Annotations to PDFDocumentAnnotationRequest.exportDocumentVersionAnnotationsToPdf
(int docId, int majorVersion, int minorVersion) Export Document Version Annotations to PDFObjectRecordRequest.getResultsOfCascadeDeleteJob
(String objectName, String jobStatus, int jobId) Get Results of Cascade Delete JobObjectRecordRequest.getResultsOfDeepCopyJob
(String objectName, boolean success, int jobId) Get Results of Deep Copy JobPicklistRequest.inactivatePicklistValue
(String picklistName, String picklistValueName) Inactivate Picklist Value
If you need to inactivate a picklist value, it is best practice to use Update Picklist Value.DocumentLifecycleRequest.initiateBulkBinderUserActions
(String userActionName, String docIds, String lifecycleName, String state) Initiate Bulk Binder User ActionsDocumentLifecycleRequest.initiateBulkDocumentUserActions
(String userActionName, String docIds, String lifecycleName, String state) Initiate Bulk Document User ActionsObjectLifecycleWorkflowRequest.initiateWorkflowAction
(int workflowId, String workflowAction) Initiate Workflow Action
Initiate a workflow action on a specific object workflow.ObjectLifecycleWorkflowRequest.initiateWorkflowTaskAction
(int taskId, String taskAction) Initiate Workflow Task ActionSandboxRequest.promoteToProduction
(String name) Given a pre-production vault, build a production vault.ObjectRecordRequest.recalculateRollupFields
(String objectName) Recalculate Roll-up FieldsSandboxRequest.recheckUsageLimit()
Recheck Sandbox Usage LimitDocumentRenditionRequest.replaceDocumentRendition
(int docId, String renditionType) Replace Document RenditionDocumentRenditionRequest.replaceDocumentVersionRendition
(int docId, int majorVersion, int minorVersion, String renditionType) Replace Document Version RenditionLogRequest.resetDebugLog
(String id) Reset Debug LogSDKRequest.resetQueue
(String queueName) Reset QueueConfigurationMigrationRequest.retrieveConfigurationReportResults
(String jobId) Retrieve Configuration Report ResultsLogRequest.retrieveDailyAPIUsage
(LocalDate logDate) Retrieve Daily API UsageDocumentAnnotationRequest.retrieveDocumentVersionNotesAsCSV
(int docId, int majorVersion, int minorVersion) Retrieve Document Version Notes as CSV
Retrieve notes in CSV format for any document that has a viewable rendition and at least one annotation.BulkTranslationRequest.retrieveImportBulkTranslationFileJobErrors
(String jobId) Retrieve Import Bulk Translation File Job ErrorsObjectRecordRequest.retrieveLimitsOnObjects()
Retrieve Limits on ObjectsLoaderRequest.retrieveLoaderExtractRenditionsResults
(int jobId, int taskId) Retrieve Loader Extract Renditions ResultsLoaderRequest.retrieveLoaderExtractResults
(int jobId, int taskId) Retrieve Loader Extract ResultsLoaderRequest.retrieveLoadFailureLogResults
(int jobId, int taskId) Retrieve Load Success Log ResultsLoaderRequest.retrieveLoadSuccessLogResults
(int jobId, int taskId) Retrieve Load Success Log ResultsSDKRequest.retrieveSigningCertificate
(String certificateId) The following endpoint allows you to retrieve a signing certificate included in a Spark message header to verify that the received message came from Vault.DocumentAnnotationRequest.retrieveVideoAnnotations
(int docId, int majorVersion, int minorVersion) Retrieve Video Annotations
Retrieve annotations on a video document.AuthenticationRequest.sessionKeepAlive()
Session Keep AliveDocumentAttachmentRequest.updateDocumentAttachmentDescription
(int docId, int attachmentId, String description) Update Document Attachment DescriptionEDLRequest.updateNodeOrder
(EDLRequest.NodeType nodeType, String parentNodeId) Given an EDL node ID, retrieves immediate children (not grandchildren) of that node.PicklistRequest.updatePicklistValue
(String picklistName, String picklistValueName, boolean status) Update Picklist Value - Status
Change a picklist value status.PicklistRequest.updatePicklistValue
(String picklistName, String picklistValueName, String newName) Update Picklist Value - Name
Change a picklist value name.UserRequest.updateVaultMembership
(int userId, int vaultId) Update Vault MembershipDocumentRenditionRequest.uploadDocumentVersionRendition
(int docId, int majorVersion, int minorVersion, String renditionType) Upload Document Version Rendition