Uses of Class
com.veeva.vault.vapil.api.model.VaultModel

Packages that use VaultModel

Package	Description
com.veeva.vault.vapil.api.model.common	Models for Vault data such as documents, object records, users, and groups
com.veeva.vault.vapil.api.model.metadata	Models for Vault metadata such as Objects, Object Fields, and Document Fields
com.veeva.vault.vapil.api.model.response	Models for Vault API responses

Uses of VaultModel in com.veeva.vault.vapil.api.model.common

Subclasses of VaultModel in com.veeva.vault.vapil.api.model.common

Modifier and Type	Class and Description
class	Binder Model for the Binder meta-data, which is an array of nodes (sections) with parent/child relationships.
static class	Binder.Node
static class	Binder.Node.BinderSection
class	BinderTemplate Model for the BinderTemplate request and responses.
class	ComponentRecord Model for the metadata component records
class	ComponentType Model for the metadata component types
static class	ComponentType.Attribute
static class	ComponentType.SubComponentType
class	Document Model for the Document Data
class	DocumentAttachment Model for the Document attachment data
static class	DocumentAttachment.Version
class	DocumentEvent
static class	DocumentEvent.Property
class	DocumentRelationship Model for the Document/Binder relationship, used in: - response of the retrieve/get - inputs to create a Document/Binder relationship
class	DocumentTemplate Model for the Document Template request and responses.
class	Group
static class	Group.ImpliedMember
class	Job
static class	Job.Link
class	LoaderTask
class	ObjectAttachment Model for the Attachment attachment metadata
static class	ObjectAttachment.Version
class	ObjectRecord Model for the Object Record data
class	PackageComponent Model for the VPK Components
class	SCIMAttribute
class	SCIMUser
static class	SCIMUser.Email
static class	SCIMUser.Meta
static class	SCIMUser.Name
static class	SCIMUser.Schema
static class	SCIMUser.SchemaUserObject
static class	SCIMUser.SchemaUserObject.ReferenceValue
class	User Model for User data

Uses of VaultModel in com.veeva.vault.vapil.api.model.metadata

Subclasses of VaultModel in com.veeva.vault.vapil.api.model.metadata

Modifier and Type	Class and Description
class	DocumentField
static class	DocumentField.UsedIn
class	DocumentLock
class	Object Model for the Vault Object metadata
static class	Object.ObjectReference
static class	Object.ObjectType
static class	Object.Relationship
static class	Object.Urls
class	ObjectField Model for the Vault Object Field metadata
static class	ObjectField.ObjectReference
class	Template Model for the BinderTemplate and DocumentTemplate Metadata
static class	User.Values

Uses of VaultModel in com.veeva.vault.vapil.api.model.response

Subclasses of VaultModel in com.veeva.vault.vapil.api.model.response

Modifier and Type	Class and Description
class	ApiVersionResponse Model for the following API calls responses:
static class	ApiVersionResponse.ApiVersion
class	AuditDetailsResponse Model for the following API calls responses:
static class	AuditDetailsResponse.ResponseDetails
static class	AuditDetailsResponse.ResponseDetails.DetailsObject
class	AuditMetadataResponse Model for the following API calls responses:
static class	AuditMetadataResponse.AuditMetadata
static class	AuditMetadataResponse.AuditMetadata.Field
class	AuditTypesResponse Model for the following API calls responses:
static class	AuditTypesResponse.AuditTrail
class	AuthenticationResponse Model for the following API calls responses:
static class	AuthenticationResponse.Vault
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
static class	BinderResponse.Renditions
static class	BinderResponse.Version
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	BulkWorkflowActionDetailsResponse.BulkWorkflowActionDetails
static class	BulkWorkflowActionDetailsResponse.Control
static class	BulkWorkflowActionDetailsResponse.Prompt
class	BulkWorkflowActionsResponse Model for the following API calls responses:
static class	BulkWorkflowActionsResponse.ActionItem
class	BulkWorkflowJobStartResponse
static class	BulkWorkflowJobStartResponse.Job
class	ComponentContentResponse Response model for the Component Content Files
static class	ComponentContentResponse.ComponentContent
static class	ComponentContentResponse.Link
class	DiscoveryResponse Model for the following API calls responses:
static class	DiscoveryResponse.DiscoveryData
static class	DiscoveryResponse.DiscoveryData.AuthProfile
static class	DiscoveryResponse.DiscoveryData.AuthProfile.AsMetadata
class	DocumentActionEntryCriteriaResponse Retrieve the entry criteria for a workflow.
static class	DocumentActionEntryCriteriaResponse.Property
static class	DocumentActionEntryCriteriaResponse.Property.ObjectTypeReferenced
class	DocumentActionInitiateResponse Response model for the following API calls:
class	DocumentActionResponse Response model for the following API calls:
static class	DocumentActionResponse.LifecycleAction
class	DocumentAnnotationResponse Model for the document annotation response
static class	DocumentAnnotationResponse.AnchorData
class	DocumentAttachmentBulkResponse Model for the document response
class	DocumentAttachmentResponse Model for the document response
class	DocumentAuditResponse Model for the following API calls responses:
static class	DocumentAuditResponse.DocumentAudit
class	DocumentBulkResponse Model for document create API response
class	DocumentClassificationResponse Model for the document classification response
static class	DocumentClassificationResponse.AvailableLifecycle
static class	DocumentClassificationResponse.RelationshipType
static class	DocumentClassificationResponse.Template
class	DocumentDeletionResponse Model for document deletions API response
static class	DocumentDeletionResponse.DeleteDocument
static class	DocumentDeletionResponse.ResponseDetails
class	DocumentEventResponse Model for the following API calls responses:
class	DocumentEventSubtypeResponse Model for the following API calls responses:
static class	DocumentEventSubtypeResponse.DocumentEventSubtype
static class	DocumentEventSubtypeResponse.DocumentEventSubtype.Value
class	DocumentEventTypeResponse Model for the following API calls responses:
static class	DocumentEventTypeResponse.Event
static class	DocumentEventTypeResponse.Event.SubType
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
static class	DocumentLifecycleDeleteOverrideRulesResponse.DeleteOverrideRule
class	DocumentLifecycleRoleAssignmentResponse Model for the Document Lifecycle Role Assignment response
static class	DocumentLifecycleRoleAssignmentResponse.RoleAssignment
class	DocumentLifecycleRoleAssignmentRulesResponse Model for lifecycle Role Assignment Rules Response API
class	DocumentLockResponse Response model for the following API calls:
static class	DocumentLockResponse.Lock
class	DocumentRelationshipBulkResponse Model for the Document Relationship Bulk responses
class	DocumentRelationshipMetadataResponse Model for the following API calls responses:
static class	DocumentRelationshipMetadataResponse.Relationship
static class	DocumentRelationshipMetadataResponse.Relationship.RelationshipObject
static class	DocumentRelationshipMetadataResponse.RelationshipProperty
static class	DocumentRelationshipMetadataResponse.RelationshipType
static class	DocumentRelationshipMetadataResponse.RelationshipType.TargetDocumentType
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}
static class	DocumentRelationshipRetrieveResponse.Relationship
class	DocumentRenditionResponse Model for the following API calls responses:
static class	DocumentRenditionResponse.Renditions
class	DocumentResponse Model for the document response
static class	DocumentResponse.Renditions
static class	DocumentResponse.Version
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	DocumentRoleCheckForDCCResponse.DocumentRoleCheckForDCC
class	DocumentRoleRetrieveResponse Model for responses to Document Role GET requests
static class	DocumentRoleRetrieveResponse.DocumentRole
class	DocumentsResponse Model for all documents API Response
class	DocumentSubtypeResponse Model for the document subtype response
static class	DocumentSubtypeResponse.DocumentClassification
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:
static class	DocumentTokenResponse.Token
class	DocumentTypeResponse Model for the document type response
static class	DocumentTypeResponse.DocumentSubtype
class	DocumentTypesResponse Model for the all document types response
static class	DocumentTypesResponse.DocumentType
class	DocumentVersionResponse Response model for the following API calls:
static class	DocumentVersionResponse.Version
class	DocumentWorkflowMetadataResponse Model for the document response
static class	DocumentWorkflowMetadataResponse.Property
static class	DocumentWorkflowMetadataResponse.Value
class	DomainAuditResponse Model for the following API calls responses:
static class	DomainAuditResponse.DomainAuditData
class	DomainResponse Model for the following API calls responses:
static class	DomainResponse.Domain
static class	DomainResponse.Domain.DomainVault
static class	DomainResponse.Domain.DomainVault.VaultFamily
class	EDLResponse Response model for an EDL API response
static class	EDLResponse.EDLNode
class	FileStagingItemBulkResponse
static class	FileStagingItemBulkResponse.FileStagingItem
static class	FileStagingItemBulkResponse.ResponseDetails
class	FileStagingItemResponse
static class	FileStagingItemResponse.FileStagingItem
class	FileStagingJobResponse Response model for the following API calls:
static class	FileStagingJobResponse.Job
class	FileStagingSessionBulkResponse
static class	FileStagingSessionBulkResponse.FileStagingSession
static class	FileStagingSessionBulkResponse.ResponseDetails
class	FileStagingSessionResponse
static class	FileStagingSessionResponse.FileStagingSession
class	GroupResponse Model for the following API calls responses:
class	GroupRetrieveResponse Model for the following API calls responses:
static class	GroupRetrieveResponse.GroupNode
class	InitiateMultiDocumentWorkflowResponse Model for the following API calls responses:
static class	InitiateMultiDocumentWorkflowResponse.MultiDocumentWorkflowData
class	JobCreateResponse Response model for the following API calls:
static class	JobCreateResponse.Warning
class	JobHistoryResponse Response model for the API Job History response
static class	JobHistoryResponse.ResponseDetails
class	JobMonitorResponse Response model for the API Job Monitor response
static class	JobMonitorResponse.ResponseDetails
class	JobStatusResponse Response model for the API Job Status response
class	JobTaskResponse Response model for the API Job Task response
static class	JobTaskResponse.JobTask
static class	JobTaskResponse.ResponseDetails
class	LoaderResponse Model for the following API calls responses:
class	LoginAuditResponse Model for the following API calls responses:
static class	LoginAuditResponse.LoginAuditData
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:
static class	MultiDocumentWorkflowDetailsResponse.Control For each control, the following data may be returned:
static class	MultiDocumentWorkflowDetailsResponse.MultiDocumentWorkflow
static class	MultiDocumentWorkflowDetailsResponse.Prompt
class	MultiDocumentWorkflowsResponse Model for the following API calls responses:
static class	MultiDocumentWorkflowsResponse.MultiDocWorkflow
class	OauthTokenResponse
class	ObjectAuditResponse Model for the following API calls responses:
static class	ObjectAuditResponse.ObjectAuditData
class	ObjectRecordActionBulkResponse Model for the following API calls responses for the Object Workflow Action operations:
class	ObjectRecordActionResponse Model for the following API calls responses:
static class	ObjectRecordActionResponse.Action
static class	ObjectRecordActionResponse.Link
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:
static class	ObjectRecordCollectionResponse.ResponseDetails
class	ObjectRecordDeletedResponse Model for Deleted Object Records recycle bin endpoint:
static class	ObjectRecordDeletedResponse.DeletedRecord
class	ObjectRecordDeletedResponse.ResponseDetails
class	ObjectRecordResponse Model for the following API calls responses for the Object Record CRUD operations:
static class	ObjectRecordResponse.ResponseDetails
class	ObjectRecordRoleChangeResponse Model for the Object Record Role API responses:
static class	ObjectRecordRoleChangeResponse.ObjectRoleChange
static class	ObjectRecordRoleChangeResponse.ObjectRoleChange.ObjectRole
class	ObjectRecordRoleResponse Model for the Object Record Role API responses:
static class	ObjectRecordRoleResponse.ObjectRole
class	ObjectRecordTypeResponse Model for the Object Record Type or Object describe API responses:
static class	ObjectRecordTypeResponse.ObjectRecordType
static class	ObjectRecordTypeResponse.ObjectRecordType.ObjectRecordTypeAction
static class	ObjectRecordTypeResponse.ObjectRecordType.ObjectRecordTypeField
class	ObjectWorkflowActionDetailsResponse Model for the following API calls responses for the Object Workflow Action Details operations:
class	ObjectWorkflowActionDetailsResponse.Control
class	ObjectWorkflowActionDetailsResponse.CurrentValue
class	ObjectWorkflowActionDetailsResponse.Prompt
class	ObjectWorkflowActionDetailsResponse.WorkflowAction
class	ObjectWorkflowActionResponse Model for the following API calls responses for the Object Workflow Action operations:
static class	ObjectWorkflowActionResponse.WorkflowAction
class	ObjectWorkflowResponse Model for the following API calls responses for the Object workflow operations:
static class	ObjectWorkflowResponse.ObjectWorkflow
static class	ObjectWorkflowResponse.ResponseDetails
class	ObjectWorkflowTaskActionDetailsResponse Model for the following API calls responses for the Object Workflow Task Action Details operations:
static class	ObjectWorkflowTaskActionDetailsResponse.Control
static class	ObjectWorkflowTaskActionDetailsResponse.Control.Prompt
static class	ObjectWorkflowTaskActionDetailsResponse.Control.Reason
static class	ObjectWorkflowTaskActionDetailsResponse.Control.Verdict
static class	ObjectWorkflowTaskActionDetailsResponse.ObjectWorkflowTaskAction
class	ObjectWorkflowTaskResponse Model for the following API calls responses for the Object WorkflowTask operations:
static class	ObjectWorkflowTaskResponse.ObjectWorkflowTask
static class	ObjectWorkflowTaskResponse.ResponseDetails
class	PackageResponse Model for the following API calls responses:
static class	PackageResponse.VaultPackage
class	PackageResultsResponse Model for the following API calls responses:
static class	PackageResultsResponse.ResponseDetails
static class	PackageResultsResponse.ResponseDetails.DeploymentLog
class	PicklistResponse Model for the following API calls
static class	PicklistResponse.Picklist
static class	PicklistResponse.Picklist.UsedIn
class	PicklistValueResponse Model for the following API calls GET /api/{version}/objects/picklists/{picklist_name}
static class	PicklistValueResponse.PicklistValue
class	QueryResponse Model for VQL query API calls
static class	QueryResponse.QueryDescribe
static class	QueryResponse.QueryDescribe.QueryObject
static class	QueryResponse.QueryResult
static class	QueryResponse.RecordProperty
static class	QueryResponse.RecordProperty.FieldAdditionalData
class	QueryResponse.ResponseDetails
class	QueueResponse Response model for the following API calls:
static class	QueueResponse.Queue
static class	QueueResponse.Queue.Connection
static class	QueueResponse.Queue.Connection.QueueError
class	SandboxEntitlementResponse
static class	SandboxEntitlementResponse.SandboxEntitlement
static class	SandboxEntitlementResponse.SandboxEntitlement.Entitlement
class	SandboxResponse
static class	SandboxResponse.Limit
static class	SandboxResponse.Sandbox
class	SCIMResponse
static class	SCIMResponse.AuthenticationScheme
static class	SCIMResponse.Bulk
static class	SCIMResponse.ChangePassword
static class	SCIMResponse.Etag
static class	SCIMResponse.Filter
static class	SCIMResponse.Meta
static class	SCIMResponse.Patch
static class	SCIMResponse.Resource
static class	SCIMResponse.Resource.Schema
static class	SCIMResponse.Sort
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
static class	SecurityPoliciesResponse.SecurityPolicy
class	SecurityPolicyResponse Model for response to requests to the Retrieve Security Policy endpoint
static class	SecurityPolicyResponse.SecurityPolicy
static class	SecurityPolicyResponse.SecurityPolicy.PolicyDetails
static class	SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings
static class	SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings.AuthenticationType
class	SystemAuditResponse Model for the following API calls responses:
static class	SystemAuditResponse.SystemAuditData
class	UserBulkResponse
class	UserPermissionResponse
static class	UserPermissionResponse.UserPermissions
static class	UserPermissionResponse.UserPermissions.PermissionSet
class	UserResponse
class	UserRetrieveResponse
static class	UserRetrieveResponse.UserNode
class	ValidatePackageResponse Response model for the following API calls:
static class	ValidatePackageResponse.ResponseDetails
static class	ValidatePackageResponse.ResponseDetails.PackageStep
class	VaultResponse Base Vault API response message
static class	VaultResponse.APIResponseError