Uses of Package
com.veeva.vault.vapil.api.model.response

Packages that use com.veeva.vault.vapil.api.model.response

Package	Description
com.veeva.vault.vapil.api.client	HTTPS Client for the Vault API
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

Classes in com.veeva.vault.vapil.api.model.response used by com.veeva.vault.vapil.api.client

Class and Description
AuthenticationResponse Model for the following API calls responses:

Classes in com.veeva.vault.vapil.api.model.response used by com.veeva.vault.vapil.api.model.response

Class and Description
ApiVersionResponse.ApiVersion
AuditDetailsResponse Model for the following API calls responses:
AuditDetailsResponse.Audit
AuditDetailsResponse.ResponseDetails
AuditDetailsResponse.ResponseDetails.DetailsObject
AuditMetadataResponse.AuditMetadata
AuditMetadataResponse.AuditMetadata.Field
AuditTypesResponse.AuditTrail
AuthenticationResponse.Vault
BinderResponse.Version
BinderTemplateBulkResponse.TemplateResult
BinderTemplateNodeBulkResponse.TemplateNodeResult
BulkWorkflowActionDetailsResponse.BulkWorkflowActionDetails
BulkWorkflowActionDetailsResponse.Control
BulkWorkflowActionDetailsResponse.Prompt
BulkWorkflowActionsResponse.ActionItem
BulkWorkflowJobStartResponse.Job
ComponentContentResponse.ComponentContent
ComponentContentResponse.Link
DelegationsResponse.DelegatedVault
DirectDataResponse.DirectDataItem
DirectDataResponse.DirectDataItem.FilePart
DirectDataResponse.ResponseDetails
DiscoveryResponse.DiscoveryData
DiscoveryResponse.DiscoveryData.AuthProfile
DiscoveryResponse.DiscoveryData.AuthProfile.AsMetadata
DocumentActionEntryCriteriaResponse.Property
DocumentActionEntryCriteriaResponse.Property.ObjectTypeReferenced
DocumentActionResponse.LifecycleAction
DocumentAnnotationDeleteResponse.DeletedAnnotation
DocumentAnnotationDeleteResponse.DeletedAnnotation.Error
DocumentAnnotationResponse.AnchorData
DocumentAttachmentResponse Model for the document response
DocumentAuditResponse.DocumentAudit
DocumentClassificationResponse Model for the document classification response
DocumentClassificationResponse.AvailableLifecycle
DocumentClassificationResponse.RelationshipType
DocumentClassificationResponse.Template
DocumentDeletionResponse.DeleteDocument
DocumentDeletionResponse.ResponseDetails
DocumentEventSubtypeResponse.DocumentEventSubtype
DocumentEventSubtypeResponse.DocumentEventSubtype.Value
DocumentEventTypeResponse.Event
DocumentEventTypeResponse.Event.SubType
DocumentExportResponse.ExportedDocument
DocumentLifecycleDeleteOverrideRulesResponse.DeleteOverrideRule
DocumentLifecycleRoleAssignmentResponse.RoleAssignment
DocumentLockResponse.Lock
DocumentRelationshipMetadataResponse.Relationship
DocumentRelationshipMetadataResponse.Relationship.RelationshipObject
DocumentRelationshipMetadataResponse.RelationshipProperty
DocumentRelationshipMetadataResponse.RelationshipType
DocumentRelationshipMetadataResponse.RelationshipType.TargetDocumentType
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}
DocumentRelationshipRetrieveResponse.Relationship
DocumentRenditionBulkResponse.Rendition
DocumentRenditionResponse.Renditions
DocumentResponse Model for the document response
DocumentResponse.Version
DocumentRoleChangeBulkResponse.DocumentRoleChange
DocumentRoleCheckForDCCResponse.DocumentRoleCheckForDCC
DocumentRoleRetrieveResponse.DocumentRole
DocumentsResponse.DocumentNode
DocumentSubtypeResponse.DocumentClassification
DocumentTemplateBulkResponse.TemplateResult
DocumentTokenResponse.Token
DocumentTypeResponse.DocumentSubtype
DocumentTypesResponse.DocumentType
DocumentVersionResponse.Version
DocumentWorkflowDetailsResponse.Control For each control, the following data may be returned:
DocumentWorkflowDetailsResponse.DocumentWorkflow
DocumentWorkflowDetailsResponse.Prompt
DocumentWorkflowResponse.DocumentWorkflow
DomainAuditResponse.DomainAuditData
DomainResponse.Domain
DomainResponse.Domain.DomainVault
DomainResponse.Domain.DomainVault.VaultFamily
EDLMatchedDocumentResponse.EdlMatchedDocument
EDLResponse.EDLNode
EmailNotificationHistoryResponse.EmailNotification
EmailNotificationHistoryResponse.ResponseDetails
FileStagingItemBulkResponse.FileStagingItem
FileStagingItemBulkResponse.ResponseDetails
FileStagingItemResponse.FileStagingItem
FileStagingJobResponse.Job
GroupRetrieveAutoManagedResponse.Data
GroupRetrieveResponse.GroupNode
InitiateDocumentWorkflowResponse.DocumentWorkflowData
JobHistoryResponse.ResponseDetails
JobMonitorResponse.ResponseDetails
JobTaskResponse.JobTask
JobTaskResponse.ResponseDetails
LoginAuditResponse.LoginAuditData
MdlResponse.CommandType
ObjectAuditResponse.ObjectAuditData
ObjectMultiRecordWorkflowDetailsResponse.Control
ObjectMultiRecordWorkflowDetailsResponse.Control.Prompt
ObjectMultiRecordWorkflowDetailsResponse.MultiRecordWorkflow
ObjectMultiRecordWorkflowInitiateResponse.MultiRecordWorkflowData
ObjectMultiRecordWorkflowsResponse.MultiRecordWorkflow
ObjectRecordActionResponse.Action
ObjectRecordActionResponse.Link
ObjectRecordAttachmentResponse Model for the following API calls responses:
ObjectRecordCollectionResponse.ResponseDetails
ObjectRecordDeletedResponse.DeletedRecord
ObjectRecordDeletedResponse.ResponseDetails
ObjectRecordMergeJobResponse.Job
ObjectRecordMergeResultsResponse.Data
ObjectRecordMergeResultsResponse.Data.MergeSet
ObjectRecordMergeResultsResponse.Data.MergeSet.Error
ObjectRecordResponse Model for the following API calls responses for the Object Record CRUD operations:
ObjectRecordResponse.ResponseDetails
ObjectRecordRoleChangeResponse.ObjectRoleChange
ObjectRecordRoleChangeResponse.ObjectRoleChange.ObjectRole
ObjectRecordRoleResponse.ObjectRole
ObjectRecordTypeResponse.ObjectRecordType
ObjectRecordTypeResponse.ObjectRecordType.ObjectRecordTypeAction
ObjectRecordTypeResponse.ObjectRecordType.ObjectRecordTypeField
ObjectWorkflowActionDetailsResponse.Control
ObjectWorkflowActionDetailsResponse.CurrentValue
ObjectWorkflowActionDetailsResponse.Prompt
ObjectWorkflowActionDetailsResponse.WorkflowAction
ObjectWorkflowActionResponse.WorkflowAction
ObjectWorkflowResponse.ObjectWorkflow
ObjectWorkflowResponse.ResponseDetails
ObjectWorkflowTaskActionDetailsResponse.Control
ObjectWorkflowTaskActionDetailsResponse.Control.Prompt
ObjectWorkflowTaskActionDetailsResponse.Control.Reason
ObjectWorkflowTaskActionDetailsResponse.Control.Verdict
ObjectWorkflowTaskActionDetailsResponse.ObjectWorkflowTaskAction
ObjectWorkflowTaskResponse.ObjectWorkflowTask
ObjectWorkflowTaskResponse.ResponseDetails
OutboundPackageDependenciesResponse.PackageDependency
OutboundPackageDependenciesResponse.ResponseDetails
PackageDeploymentResultsResponse.ResponseDetails
PackageImportResultsResponse.VaultImportPackage
PicklistResponse.Picklist
PicklistResponse.Picklist.UsedIn
PicklistValueResponse.PicklistValue
QueryResponse Model for VQL query API calls
QueryResponse.QueryDescribe
QueryResponse.QueryDescribe.QueryObject
QueryResponse.QueryResult
QueryResponse.RecordProperty
QueryResponse.RecordProperty.FieldAdditionalData
QueryResponse.ResponseDetails
QueueResponse.Queue
QueueResponse.Queue.Connection
QueueResponse.Queue.Connection.QueueError
SandboxDetailsResponse.Entitlement
SandboxDetailsResponse.Sandbox
SandboxEntitlementResponse.SandboxEntitlement
SandboxEntitlementResponse.SandboxEntitlement.Entitlement
SandboxResponse.Entitlement
SandboxResponse.Sandbox
SandboxResponse.SourceVault
SandboxSnapshotResponse.Sandbox
SandboxSnapshotResponse.Snapshot
SCIMResponse.AuthenticationScheme
SCIMResponse.Bulk
SCIMResponse.ChangePassword
SCIMResponse.Etag
SCIMResponse.Filter
SCIMResponse.Meta
SCIMResponse.Patch
SCIMResponse.Resource
SCIMResponse.Resource.Schema
SCIMResponse.Sort
SecurityPoliciesResponse.SecurityPolicy
SecurityPolicyResponse.SecurityPolicy
SecurityPolicyResponse.SecurityPolicy.PolicyDetails
SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings
SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings.AuthenticationType
SystemAuditResponse.SystemAuditData
UserPermissionResponse.UserPermissions
UserPermissionResponse.UserPermissions.PermissionSet
UserResponse
UserRetrieveResponse.UserNode
ValidatePackageResponse.ResponseDetails
VaultResponse Base Vault API response message
VaultResponse.APIResponseError
VaultResponse.APIResponseWarning

Classes in com.veeva.vault.vapil.api.model.response used by com.veeva.vault.vapil.api.request

Class and Description
ApiVersionResponse Model for the following API calls responses:
AuditMetadataResponse Model for the following API calls responses:
AuditTypesResponse Model for the following API calls responses:
AuthenticationResponse Model for the following API calls responses:
BinderExportResponse Model for Retrieve Binder Export Results GET /api/{version}/objects/binders/batch/actions/export/{jobid}/results
BinderResponse Model for the binder response
BinderSectionResponse Model for the binder section response, needed to handle: 1.
BinderTemplateBulkResponse Model for the Template responses
BinderTemplateMetadataResponse Model for the following API calls responses:
BinderTemplateNodeBulkResponse Model for the Template responses
BinderTemplateResponse Model for the Binder Template responses
BulkWorkflowActionDetailsResponse Model for the following API calls responses:
BulkWorkflowActionsResponse Model for the following API calls responses:
BulkWorkflowJobStartResponse
ComponentContentResponse Response model for the Component Content Files
DelegatedSessionResponse Model for responses to Initiate Delegated Session API:
DelegationsResponse Model for responses to Retrieve Delegations API:
DirectDataResponse Response model for the following API calls:
DiscoveryResponse Model for the following API calls responses:
DocumentActionEntryCriteriaResponse Retrieve the entry criteria for a workflow.
DocumentActionInitiateResponse Response model for the following API calls:
DocumentActionResponse Response model for the following API calls:
DocumentAnnotationDeleteResponse Model for the delete document annotations response
DocumentAnnotationReadResponse Model for document annotation read response
DocumentAnnotationReplyReadResponse Model for document annotation reply read response
DocumentAnnotationResponse Model for the document annotation response
DocumentAttachmentBulkResponse Model for the document response
DocumentAttachmentResponse Model for the document response
DocumentAuditResponse Model for the following API calls responses:
DocumentBulkResponse Model for document create API response
DocumentClassificationResponse Model for the document classification response
DocumentDeletionResponse Model for document deletions API response
DocumentEventResponse Model for the following API calls responses:
DocumentEventSubtypeResponse Model for the following API calls responses:
DocumentEventTypeResponse Model for the following API calls responses:
DocumentExportResponse Model for document export API response
DocumentFieldResponse Model for the document field response
DocumentLifecycleDeleteOverrideRulesResponse Model for lifecycle Role Assignment Rules Response API
DocumentLifecycleRoleAssignmentResponse Model for the Document Lifecycle Role Assignment response
DocumentLifecycleRoleAssignmentRulesResponse Model for lifecycle Role Assignment Rules Response API
DocumentLockResponse Response model for the following API calls:
DocumentRelationshipBulkResponse Model for the Document Relationship Bulk responses
DocumentRelationshipMetadataResponse Model for the following API calls responses:
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}
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}
DocumentRenditionBulkResponse Model for the following API calls responses:
DocumentRenditionResponse Model for the following API calls responses:
DocumentResponse Model for the document response
DocumentRoleChangeBulkResponse Model for responses to bulk Document Role Requests
DocumentRoleChangeResponse Model for responses to single Document Role Update and Delete requests
DocumentRoleRetrieveResponse Model for responses to Document Role GET requests
DocumentsResponse Model for all documents API Response
DocumentSubtypeResponse Model for the document subtype response
DocumentTemplateBulkResponse Model for the Template responses
DocumentTemplateMetadataResponse Model for the following API calls responses:
DocumentTemplateResponse Model for the document template response
DocumentTemplatesResponse Model for the document templates response
DocumentTokenResponse Response model for the following API calls:
DocumentTypeResponse Model for the document type response
DocumentTypesResponse Model for the all document types response
DocumentVersionResponse Response model for the following API calls:
DocumentWorkflowDetailsResponse Model for the following API calls responses:
DocumentWorkflowResponse Model for the following API calls responses:
DomainResponse Model for the following API calls responses:
EDLMatchedDocumentResponse Response model for an EDL Matched Document Add and Remove Response
EDLResponse Response model for an EDL API response
FileStagingItemBulkResponse
FileStagingItemResponse
FileStagingJobResponse Response model for the following API calls:
FileStagingSessionBulkResponse
FileStagingSessionPartBulkResponse
FileStagingSessionPartResponse
FileStagingSessionResponse
GroupResponse Model for the following API calls responses:
GroupRetrieveAutoManagedResponse
GroupRetrieveResponse Model for the following API calls responses:
InitiateDocumentWorkflowResponse Model for the following API calls responses:
JobCreateResponse Response model for the following API calls:
JobHistoryResponse Response model for the API Job History response
JobMonitorResponse Response model for the API Job Monitor response
JobStatusResponse Response model for the API Job Status response
JobTaskResponse Response model for the API Job Task response
LoaderResponse Model for the following API calls responses:
MdlResponse Response model for the following API calls:
MetaDataComponentRecordResponse Response model for the following API calls:
MetaDataComponentTypeBulkResponse Response model for the following API calls:
MetaDataComponentTypeResponse Response model for the following API calls:
MetaDataDocumentLockResponse
MetaDataGroupResponse Response model for the following API call:
MetaDataObjectBulkResponse Response model for the following API calls:
MetaDataObjectFieldResponse Response model for the following API calls:
MetaDataObjectPageLayoutResponse Response model for the following API calls:
MetaDataObjectResponse Response model for the following API calls:
MetaDataSecurityPolicyResponse
MetaDataUserResponse
ObjectAuditResponse Model for the following API calls responses:
ObjectMultiRecordWorkflowDetailsResponse Retrieve Multi-Record Workflow Details
ObjectMultiRecordWorkflowInitiateResponse Model for the following API calls responses:
ObjectMultiRecordWorkflowsResponse Retrieve Multi-Record Workflows
ObjectRecordActionBulkResponse Model for the following API calls responses for the Object Workflow Action operations:
ObjectRecordActionResponse Model for the following API calls responses:
ObjectRecordAttachmentResponse Model for the following API calls responses:
ObjectRecordBulkResponse Model for the following API calls responses for the Object Record CUD operations:
ObjectRecordCollectionResponse Model for the following API calls responses for the Object Record CRUD operations:
ObjectRecordDeletedResponse Model for Deleted Object Records recycle bin endpoint:
ObjectRecordMergeJobResponse Model for the following API calls responses:
ObjectRecordMergeResultsResponse Model for the following API calls responses:
ObjectRecordResponse Model for the following API calls responses for the Object Record CRUD operations:
ObjectRecordRoleChangeResponse Model for the Object Record Role API responses:
ObjectRecordRoleResponse Model for the Object Record Role API responses:
ObjectRecordTypeResponse Model for the Object Record Type or Object describe API responses:
ObjectWorkflowActionDetailsResponse Model for the following API calls responses for the Object Workflow Action Details operations:
ObjectWorkflowActionResponse Model for the following API calls responses for the Object Workflow Action operations:
ObjectWorkflowResponse Model for the following API calls responses for the Object workflow operations:
ObjectWorkflowTaskActionDetailsResponse Model for the following API calls responses for the Object Workflow Task Action Details operations:
ObjectWorkflowTaskResponse Model for the following API calls responses for the Object WorkflowTask operations:
OutboundPackageDependenciesResponse
PackageDeploymentResultsResponse Model for the following API calls responses:
PackageImportResultsResponse
PicklistResponse Model for the following API calls
PicklistValueResponse Model for the following API calls GET /api/{version}/objects/picklists/{picklist_name}
QueryResponse Model for VQL query API calls
QueueResponse Response model for the following API calls:
SandboxDetailsResponse
SandboxEntitlementResponse
SandboxResponse
SandboxSnapshotResponse
SCIMResponse
SCIMUserBulkResponse
SCIMUserResponse
SDKResponse Response model for the following API calls:
SecurityPoliciesResponse Model for response to requests to the Retrieve Security Policies endpoint
SecurityPolicyResponse Model for response to requests to the Retrieve Security Policy endpoint
UserBulkResponse
UserPermissionResponse
UserResponse
UserRetrieveResponse
ValidatePackageResponse Response model for the following API calls:
VaultResponse Base Vault API response message