Uses of Class
com.veeva.vault.vapil.api.model.response.VaultResponse

Packages that use VaultResponse

Package	Description
com.veeva.vault.vapil.api.model.response	Models for Vault API responses
com.veeva.vault.vapil.api.request	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.response

Modifier and Type	Class and Description
class	ApiVersionResponse Model for the following API calls responses:
class	AuditDetailsResponse Model for the following API calls responses:
class	AuditMetadataResponse Model for the following API calls responses:
class	AuditTypesResponse Model for the following API calls responses:
class	AuthenticationResponse Model for the following API calls responses:
class	BinderExportResponse Model for Retrieve Binder Export Results GET /api/{version}/objects/binders/batch/actions/export/{jobid}/results
class	BinderResponse Model for the binder response
class	BinderSectionResponse Model for the binder section response, needed to handle: 1.
class	BinderTemplateBulkResponse Model for the Template responses
static class	BinderTemplateBulkResponse.TemplateResult
class	BinderTemplateMetadataResponse Model for the following API calls responses:
class	BinderTemplateNodeBulkResponse Model for the Template responses
static class	BinderTemplateNodeBulkResponse.TemplateNodeResult
class	BinderTemplateResponse Model for the Binder Template responses
class	BulkWorkflowActionDetailsResponse Model for the following API calls responses:
class	BulkWorkflowActionsResponse Model for the following API calls responses:
class	BulkWorkflowJobStartResponse
class	ComponentContentResponse Response model for the Component Content Files
class	DiscoveryResponse Model for the following API calls responses:
class	DocumentActionEntryCriteriaResponse Retrieve the entry criteria for a workflow.
class	DocumentActionInitiateResponse Response model for the following API calls:
class	DocumentActionResponse Response model for the following API calls:
class	DocumentAnnotationResponse Model for the document annotation response
class	DocumentAttachmentBulkResponse Model for the document response
class	DocumentAttachmentResponse Model for the document response
class	DocumentAuditResponse Model for the following API calls responses:
class	DocumentBulkResponse Model for document create API response
class	DocumentClassificationResponse Model for the document classification response
class	DocumentDeletionResponse Model for document deletions API response
class	DocumentEventResponse Model for the following API calls responses:
class	DocumentEventSubtypeResponse Model for the following API calls responses:
class	DocumentEventTypeResponse Model for the following API calls responses:
class	DocumentExportResponse Model for document export API response
static class	DocumentExportResponse.ExportedDocument
class	DocumentFieldResponse Model for the document field response
class	DocumentLifecycleDeleteOverrideRulesResponse Model for lifecycle Role Assignment Rules Response API
class	DocumentLifecycleRoleAssignmentResponse Model for the Document Lifecycle Role Assignment response
class	DocumentLifecycleRoleAssignmentRulesResponse Model for lifecycle Role Assignment Rules Response API
class	DocumentLockResponse Response model for the following API calls:
class	DocumentRelationshipBulkResponse Model for the Document Relationship Bulk responses
class	DocumentRelationshipMetadataResponse Model for the following API calls responses:
class	DocumentRelationshipResponse 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	DocumentRelationshipRetrieveResponse 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	DocumentRenditionResponse Model for the following API calls responses:
class	DocumentResponse Model for the document response
class	DocumentRoleChangeBulkResponse Model for responses to bulk Document Role Requests
static class	DocumentRoleChangeBulkResponse.DocumentRoleChange
class	DocumentRoleChangeResponse Model for responses to single Document Role Update and Delete requests
class	DocumentRoleCheckForDCCResponse Model for Document Role Check for Document Change Control response
class	DocumentRoleRetrieveResponse Model for responses to Document Role GET requests
class	DocumentsResponse Model for all documents API Response
class	DocumentSubtypeResponse Model for the document subtype response
class	DocumentTemplateBulkResponse Model for the Template responses
static class	DocumentTemplateBulkResponse.TemplateResult
class	DocumentTemplateMetadataResponse Model for the following API calls responses:
class	DocumentTemplateResponse Model for the document template response
class	DocumentTemplatesResponse Model for the document templates response
class	DocumentTokenResponse Response model for the following API calls:
class	DocumentTypeResponse Model for the document type response
class	DocumentTypesResponse Model for the all document types response
class	DocumentVersionResponse Response model for the following API calls:
class	DocumentWorkflowMetadataResponse Model for the document response
class	DomainAuditResponse Model for the following API calls responses:
class	DomainResponse Model for the following API calls responses:
class	EDLResponse Response model for an EDL API response
class	FileStagingItemBulkResponse
class	FileStagingItemResponse
class	FileStagingJobResponse Response model for the following API calls:
class	FileStagingSessionBulkResponse
class	FileStagingSessionResponse
class	GroupResponse Model for the following API calls responses:
class	GroupRetrieveResponse Model for the following API calls responses:
class	InitiateMultiDocumentWorkflowResponse Model for the following API calls responses:
class	JobCreateResponse Response model for the following API calls:
class	JobHistoryResponse Response model for the API Job History response
class	JobMonitorResponse Response model for the API Job Monitor response
class	JobStatusResponse Response model for the API Job Status response
class	JobTaskResponse Response model for the API Job Task response
class	LoaderResponse Model for the following API calls responses:
class	LoginAuditResponse Model for the following API calls responses:
class	MdlResponse Response model for the following API calls:
class	MetaDataComponentRecordResponse Response model for the following API calls:
class	MetaDataComponentTypeBulkResponse Response model for the following API calls:
class	MetaDataComponentTypeResponse Response model for the following API calls:
class	MetaDataDocumentLockResponse
class	MetaDataGroupResponse Response model for the following API call:
class	MetaDataObjectBulkResponse Response model for the following API calls:
class	MetaDataObjectFieldResponse Response model for the following API calls:
class	MetaDataObjectResponse Response model for the following API calls:
class	MetaDataUserResponse
class	MultiDocumentWorkflowDetailsResponse Model for the following API calls responses:
class	MultiDocumentWorkflowsResponse Model for the following API calls responses:
class	ObjectAuditResponse Model for the following API calls responses:
class	ObjectRecordActionBulkResponse Model for the following API calls responses for the Object Workflow Action operations:
class	ObjectRecordActionResponse Model for the following API calls responses:
class	ObjectRecordAttachmentResponse Model for the following API calls responses:
class	ObjectRecordBulkResponse Model for the following API calls responses for the Object Record CUD operations:
class	ObjectRecordCollectionResponse Model for the following API calls responses for the Object Record CRUD operations:
class	ObjectRecordDeletedResponse Model for Deleted Object Records recycle bin endpoint:
class	ObjectRecordResponse Model for the following API calls responses for the Object Record CRUD operations:
class	ObjectRecordRoleChangeResponse Model for the Object Record Role API responses:
class	ObjectRecordRoleResponse Model for the Object Record Role API responses:
class	ObjectRecordTypeResponse Model for the Object Record Type or Object describe API responses:
class	ObjectWorkflowActionDetailsResponse Model for the following API calls responses for the Object Workflow Action Details operations:
class	ObjectWorkflowActionResponse Model for the following API calls responses for the Object Workflow Action operations:
class	ObjectWorkflowResponse Model for the following API calls responses for the Object workflow operations:
class	ObjectWorkflowTaskActionDetailsResponse Model for the following API calls responses for the Object Workflow Task Action Details operations:
class	ObjectWorkflowTaskResponse Model for the following API calls responses for the Object WorkflowTask operations:
class	PackageResponse Model for the following API calls responses:
class	PackageResultsResponse Model for the following API calls responses:
class	PicklistResponse Model for the following API calls
class	PicklistValueResponse Model for the following API calls GET /api/{version}/objects/picklists/{picklist_name}
class	QueryResponse Model for VQL query API calls
class	QueueResponse Response model for the following API calls:
class	SandboxEntitlementResponse
class	SandboxResponse
class	SCIMResponse
class	SCIMUserBulkResponse
class	SCIMUserResponse
class	SDKResponse Response model for the following API calls:
class	SecurityPoliciesResponse Model for response to requests to the Retrieve Security Policies endpoint
class	SecurityPolicyResponse Model for response to requests to the Retrieve Security Policy endpoint
class	SystemAuditResponse Model for the following API calls responses:
class	UserBulkResponse
class	UserPermissionResponse
class	UserResponse
class	UserRetrieveResponse
class	ValidatePackageResponse Response model for the following API calls:

Methods in com.veeva.vault.vapil.api.model.response that return types with arguments of type VaultResponse

Modifier and Type	Method and Description
List<VaultResponse>	DocumentLifecycleRoleAssignmentRulesResponse.getData()

Method parameters in com.veeva.vault.vapil.api.model.response with type arguments of type VaultResponse

Modifier and Type	Method and Description
void	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 VaultResponse

Modifier and Type	Method and Description
VaultResponse	FileStagingRequest.abortUploadSession(String uploadSessionId) Abort Upload Session
VaultResponse	DocumentRenditionRequest.addMultipleDocumentRenditions() Add Multiple Document Renditions Add document renditions in bulk.
VaultResponse	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 use DocumentRenditionRequest.addMultipleDocumentRenditions()
VaultResponse	DocumentLifecycleWorkflowRequest.bulkDocumentStateChange(DocumentRequestType requestType, String userActionName, String docIds) Bulk Document State Change.
VaultResponse	UserRequest.changePassword(int userId, String currentPassword, String newPassword) Change Your Password
VaultResponse	DocumentEventRequest.createDocumentEvent(int docId, int majorVersion, int minorVersion, DocumentEvent.Property eventProperties) Create Document Event
VaultResponse	DocumentRequest.createDocumentLock(int docId) Create Document Lock
VaultResponse	DocumentRequest.deleteDocumentLock(int docId) Deleting Document Lock
VaultResponse	DocumentRenditionRequest.deleteDocumentVersionRendition(int docId, int majorVersion, int minorVersion, String renditionType) Delete Document Version Rendition
VaultResponse	DocumentRenditionRequest.deleteMultipleDocumentRenditions() Delete Multiple Document Renditions
VaultResponse	SandboxRequest.deleteSandbox(String name) Delete a sandbox vault.
VaultResponse	DocumentAttachmentRequest.deleteSingleDocumentAttachment(int docId, int attachmentId) Delete Single Document Attachment
VaultResponse	DocumentAttachmentRequest.deleteSingleDocumentAttachmentVersion(int docId, int attachmentId, int attachmentVersion) Delete Single Document Attachment Version
VaultResponse	DocumentRenditionRequest.deleteSingleDocumentRendition(int docId, String renditionType) Delete Single Document Rendition
VaultResponse	SDKRequest.deleteSingleSourceCodeFile(String className) Delete Single Source Code File
VaultResponse	SDKRequest.disableDelivery(String queueName) Disable Delivery
VaultResponse	DocumentAttachmentRequest.downloadAllDocumentAttachments(int docId) Download All Document Attachments
VaultResponse	DocumentAttachmentRequest.downloadAllDocumentVersionAttachments(int docId, int majorVersionNumber, int minorVersionNumber) Download All Document Version Attachments
VaultResponse	ObjectRecordAttachmentRequest.downloadAllObjectRecordAttachmentFiles(String objectName, String recordId) Download All Object Record Attachment Files
VaultResponse	DocumentLifecycleWorkflowRequest.downloadControlledCopyJobResult(String lifecycleStateAction, int jobId) Download Controlled Copy Job Results.
VaultResponse	DocumentAttachmentRequest.downloadDocumentAttachment(int docId, int attachmentId) Download Document Attachment
VaultResponse	DocumentAttachmentRequest.downloadDocumentAttachmentVersion(int docId, int attachmentId, int attachVersionId) Download Document Attachment Version
VaultResponse	DocumentRequest.downloadDocumentFile(int docId) Download Document File
VaultResponse	DocumentRenditionRequest.downloadDocumentRenditionFile(int docId, String renditionType) Download Document Rendition File
VaultResponse	DocumentRenditionRequest.downloadDocumentRenditionFile(int docId, String renditionType, Boolean steadyState) Download Document Rendition File
VaultResponse	DocumentTemplateRequest.downloadDocumentTemplateFile(String templateName) Download Document Template File
VaultResponse	DocumentAttachmentRequest.downloadDocumentVersionAttachment(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId) Download Document Version Attachment
VaultResponse	DocumentAttachmentRequest.downloadDocumentVersionAttachmentVersion(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId, int attachVersionId) Download Document Version Attachment Version
VaultResponse	DocumentRequest.downloadDocumentVersionFile(int docId, int majorVersion, int minorVersion) Download Document Version File
VaultResponse	DocumentRenditionRequest.downloadDocumentVersionRenditionFile(int docId, int majorVersion, int minorVersion, String renditionType) Download Document Version Rendition File
VaultResponse	DocumentRequest.downloadDocumentVersionThumbnailFile(int docId, int majorVersion, int minorVersion) Download Document Version Thumbnail File
VaultResponse	ObjectRecordAttachmentRequest.downloadObjectRecordAttachmentFile(String objectName, String recordId, int attachmentId) Download Object Record Attachment File
VaultResponse	ObjectRecordAttachmentRequest.downloadObjectRecordAttachmentVersionFile(String objectName, String recordId, int attachmentId, int versionId) Download Object Record Attachment Version File
VaultResponse	SDKRequest.enableDelivery(String queueName) Enable Delivery
VaultResponse	MetaDataRequest.executeMDLScript() Execute MDL Script
VaultResponse	FileStagingRequest.getItemContent(String item) Get Item Content
VaultResponse	ObjectRecordRequest.getResultsOfCascadeDeleteJob(String objectName, String jobStatus, int jobId) Get Results of Cascade Delete Job
VaultResponse	ObjectRecordRequest.getResultsOfDeepCopyJob(String objectName, boolean success, int jobId) Get Results of Deep Copy Job
VaultResponse	PicklistRequest.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.
VaultResponse	ObjectLifecycleWorkflowRequest.initiateWorkflowAction(int workflowId, String workflowAction) Initiate Workflow Action Initiate a workflow action on a specific object workflow.
VaultResponse	ObjectLifecycleWorkflowRequest.initiateWorkflowTaskAction(int taskId, String taskAction) Initiate Workflow Task Action
VaultResponse	DocumentRenditionRequest.replaceDocumentRendition(int docId, String renditionType) Replace Document Rendition
VaultResponse	DocumentRenditionRequest.replaceDocumentVersionRendition(int docId, int majorVersion, int minorVersion, String renditionType) Replace Document Version Rendition
VaultResponse	SDKRequest.resetQueue(String queueName) Reset Queue
VaultResponse	LogRequest.retrieveDailyAPIUsage() Retrieve Daily API Usage
VaultResponse	DocumentAnnotationRequest.retrieveDocumentAnnotations(int docId) Retrieve Document Annotations
VaultResponse	DocumentAnnotationRequest.retrieveDocumentVersionAnnotations(int docId, int majorVersion, int minorVersion) Retrieve Document Version Annotations
VaultResponse	DocumentAnnotationRequest.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.
VaultResponse	DomainRequest.retrieveDomains() Retrieve Domains
VaultResponse	LoaderRequest.retrieveExtractRenditionResults(int jobId, int taskId) Retrieve Loader Extract Renditions Results
VaultResponse	LoaderRequest.retrieveExtractResults(int jobId, int taskId) Retrieve Extract Results
VaultResponse	ObjectRecordRequest.retrieveLimitsOnObjects() Retrieve Limits on Objects
VaultResponse	LoaderRequest.retrieveLoadFailureLogResults(int jobId, int taskId) Retrieve Load Success Log Results
VaultResponse	LoaderRequest.retrieveLoadSuccessLogResults(int jobId, int taskId) Retrieve Load Success Log Results
VaultResponse	SDKRequest.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.
VaultResponse	DocumentAnnotationRequest.retrieveVideoAnnotations(int docId, int majorVersion, int minorVersion) Retrieve Video Annotations Retrieve annotations on a video document.
VaultResponse	DocumentAttachmentRequest.updateDocumentAttachmentDescription(int docId, int attachmentId, String description) Update Document Attachment Description
VaultResponse	EDLRequest.updateNodeOrder(EDLRequest.NodeType nodeType, String parentNodeId) Given an EDL node ID, retrieves immediate children (not grandchildren) of that node.
VaultResponse	PicklistRequest.updatePicklistValue(String picklistName, String picklistValueName, boolean status) Update Picklist Value - Status Change a picklist value status.
VaultResponse	PicklistRequest.updatePicklistValue(String picklistName, String picklistValueName, String newName) Update Picklist Value - Name Change a picklist value name.
VaultResponse	UserRequest.updateVaultMembership(int userId, int vaultId) Update Vault Membership
VaultResponse	DocumentRenditionRequest.uploadDocumentVersionRendition(int docId, int majorVersion, int minorVersion, String renditionType) Upload Document Version Rendition