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 TypeClassDescriptionclassResponse Model for calls to the Document and Binder User Action endpoints:classResponse Model for calls to the Document and Binder User Action endpoints:classModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses:classRetrieve document entry criteria.classResponse model for the following API calls:classResponse model for the following API calls:classModel for Retrieve Binder Export Results
GET /api/{version}/objects/binders/batch/actions/export/{jobid}/resultsclassModel for the binder responseclassModel for responses to bulk Document Role Requests TODOclassModel for responses to single Document Role Update and Delete requests TODOclassModel for responses to Binder Role GET requests TODO: add endpointsclassModel for the binder section response, needed to handle:
1.classModel for the Template responsesstatic classclassModel for the following API calls responses:classModel for the Template responsesstatic classclassModel for the Binder Template responsesclassResponse model for the following API calls:classResponse model for the following API calls:classModel for the following API calls responses:classModel for the following API calls responses:classclassResponse model for the Component Content FilesclassResponse model for the Component Definition QueryclassModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses:classModel for responses to Initiate Delegated Session API:classModel for responses to Retrieve Delegations API:classResponse model for the following API calls:classModel for the following API calls responses:classRetrieve document entry criteria.classResponse model for the following API calls:classResponse model for the following API calls:classModel for the document annotation import responseclassModel for the document annotation bulk responsesclassModel for the delete document annotations responseclassModel for the document annotation import responseclassModel for the document annotation responseclassModel for document annotation read responseclassModel for the document annotation responseclassModel for document annotation reply read responseclassModel for the document annotation responseclassModel for the document responseclassModel for the document responseclassModel for the following API calls responses:classModel for document create API responseclassModel for the document classification responseclassModel for the Undo Collaborative Authoring Checkout response:
DELETE /api/{version}/objects/documents/batch/lockstatic classclassModel for document deletions API responseclassModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses:classModel for document export API responsestatic classclassModel for the document field responseclassModel for lifecycle Role Assignment Rules Response APIclassModel for the Document Lifecycle Role Assignment responseclassModel for lifecycle Role Assignment Rules Response APIclassResponse model for the following API calls:classModel for the Document Relationship Bulk responsesclassModel for the following API calls responses:classModel 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}classModel 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}classModel for the following API calls responses:classModel for the following API calls responses:classModel for the document responseclassModel for responses to bulk Document Role Requests TODOclassModel for responses to single Document Role Update and Delete requests TODOclassModel for Document Role Check for Document Change Control responseclassModel for responses to Document Role GET requests TODO: add endpointsclassModel for the following API calls responses:classModel for all documents API ResponseclassModel for the document subtype responseclassModel for the Template responsesstatic classclassModel for the following API calls responses:classModel for the document template responseclassModel for the document templates responseclassResponse model for the following API calls:classModel for the document type responseclassModel for the all document types responseclassResponse model for the following API calls:classModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses:classResponse model for an EDL Matched Document Add and Remove ResponseclassResponse model for an EDL API responseclassModel for email notifications API ResponseclassResponse Model for calls to the Document and Binder User Action endpoints:classclassclassResponse model for the following API calls:classclassclassclassclassModel for the following API calls responses:classclassModel for the following API calls responses:classModel for the following API calls responses:classResponse model for the following API calls:classResponse model for the API Job History responseclassResponse model for the API Job Monitor responseclassResponse model for the API Job Status responseclassResponse model for the API Job Task responseclassModel for the following API calls responses:classModel for the following API calls responses:classResponse model for the following API calls:classResponse model for the following API calls:classResponse model for the following API calls:classResponse model for the following API calls:classResponse model for the following API calls:classclassResponse model for the following API call:classResponse model for the following API calls:classResponse model for the following API calls:classResponse model for the following API calls:classResponse model for the following API calls:classclassclassModel for the following API calls responses:classRetrieve Multi-Record Workflow DetailsclassModel for the following API calls responses:classRetrieve Multi-Record WorkflowsclassModel for the following API calls responses for the Object Workflow Action operations:classModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses for the Object Record CUD operations:classModel for the following API calls responses for the Object Record CRUD operations:classModel for Deleted Object Records recycle bin endpoint:classModel for the following API calls responses:classModel for the following API calls responses:classModel for the following API calls responses for the Object Record CRUD operations:classModel for the Object Record Role API responses:classModel for the Object Record Role API responses:classModel for the Object Record Type or Object describe API responses:static classclassModel for the Object Record Type or Object describe API responses:classModel for the following API calls responses for the Object Workflow Action Details operations:classModel for the following API calls responses for the Object Workflow Action operations:classModel for the following API calls responses for the Object workflow operations:classModel for the following API calls responses for the Object Workflow Task Action Details operations:classModel for the following API calls responses for the Object WorkflowTask operations:classclassModel for the following API calls responses:classclassModel for the following API callsclassModel for the following API calls
GET /api/{version}/objects/picklists/{picklist_name}classModel for VQL query API callsclassResponse model for the following API calls:classResponse Model for calls to the Document and Binder Single Role assign endpoints:static classclassResponse Model for calls to the Document and Binder Single Role assign endpoints:classResponse Model for calls to the Document and Binder Role Retrieve endpoints:classclassclassclassclassclassclassclassclassstatic classclassclassclassstatic classclassclassResponse model for the following API calls:classModel for response to requests to the Retrieve Security Policies endpointclassModel for response to requests to the Retrieve Security Policy endpointclassModel for the following API calls responses:classclassclassclassclassclassResponse 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 TypeMethodDescriptionvoidDocumentLifecycleRoleAssignmentRulesResponse.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