Package | Description |
---|---|
com.veeva.vault.vapil.api.request |
Methods to perform Vault API calls, with each method mapping to a Vault API endpoint
|
Modifier and Type | Method and Description |
---|---|
DocumentRequest |
DocumentRequest.setBinaryFile(String filename,
byte[] binaryContent)
Specify source data in an input file
|
DocumentRequest |
DocumentRequest.setBoundSourceMajorVersion(Integer boundSourceMajorVersion)
Specify the Cross-Link Bound Source Major Version
|
DocumentRequest |
DocumentRequest.setBoundSourceMinorVersion(Integer boundSourceMinorVersion)
Specify the Cross-Link Bound Source Minor Version
|
DocumentRequest |
DocumentRequest.setChannel(String channel)
Include the channel request parameter set to the website object record id value
that corresponds to the distribution channel where the document is being made available.
|
DocumentRequest |
DocumentRequest.setContentTypeCsv()
Set the Header Content Type to CSV
|
DocumentRequest |
DocumentRequest.setContentTypeJson()
Set the Header Content Type to JSON
|
DocumentRequest |
DocumentRequest.setDescription(String description)
Specify description
|
DocumentRequest |
DocumentRequest.setDownloadOption(DocumentRequest.DownloadOption downloadOption)
Include the downloadOption request parameter set to PDF, source, both, or none.
|
DocumentRequest |
DocumentRequest.setEndData(String endDate)
Set the end date, used to set end date Retrieve Deleted Document IDs API
|
DocumentRequest |
DocumentRequest.setExpiryDateOffset(Integer expiryDateOffset)
Specify number of days after which the tokens will expire
and the documents will no longer be available in the viewer.
|
DocumentRequest |
DocumentRequest.setIdParam(String idParam)
Specify an UPSERT operation via the idParam
|
DocumentRequest |
DocumentRequest.setInputPath(String inputPath)
Specify source data in an input file
|
DocumentRequest |
DocumentRequest.setLimit(Integer limit)
Set the limit of documents returned by retrieve all documents
|
DocumentRequest |
DocumentRequest.setLockDocument(Boolean lockDocument)
Specify to check out the document before retrieval
|
DocumentRequest |
DocumentRequest.setMigrationMode(boolean migrationMode)
Enable migration mode to create multiple document versions in bulk
and perform manual assignment of documents numbers.
|
DocumentRequest |
DocumentRequest.setOffset(Integer offset)
Set the offset, used to paginate Retrieve Deleted Document IDs API
|
DocumentRequest |
DocumentRequest.setOutputPath(String outputPath)
Specify source data in an output file
|
DocumentRequest |
DocumentRequest.setRequestString(String requestString)
Specify source data in an input string, such as a JSON request
|
DocumentRequest |
DocumentRequest.setScopeFilter(DocumentRequest.NamedFilter namedFilter)
Set named filter of documents returned by retrieve all documents
|
DocumentRequest |
DocumentRequest.setScopeFilter(DocumentRequest.Scope scope)
Set scope of documents returned by retrieve all documents
|
DocumentRequest |
DocumentRequest.setSearchKeyword(String keyword)
Search keyword for documents returned by retrieve all documents
|
DocumentRequest |
DocumentRequest.setSort(String sort)
Sort for documents returned by retrieve all documents
|
DocumentRequest |
DocumentRequest.setSourceBindingRule(DocumentRequest.CrosslinkBinding sourceBindingRule)
Specify the Cross-Link Source Binding Rule
|
DocumentRequest |
DocumentRequest.setStart(Integer start)
Set the starting position of documents returned by retrieve all documents
|
DocumentRequest |
DocumentRequest.setStartData(String startDate)
Set the start date, used to set start date for Retrieve Deleted Document IDs API
|
DocumentRequest |
DocumentRequest.setSteadyState(Boolean steadyState)
Document Tokens:
If set to true, Vault generates a token for the latest steady state version of a document.
|
DocumentRequest |
DocumentRequest.setSuppressRendition(Boolean suppressRendition)
Specify whether to suppress rendition
|
DocumentRequest |
DocumentRequest.setTokenGroup(String tokenGroup)
This only required if you want to group together generated tokens for multiple documents
in order to display the documents being referenced in the same viewer.
|
DocumentRequest |
DocumentRequest.setVersionScope(DocumentRequest.VersionsScope versionsScope)
Set all versions or latest version of documents returned by retrieve all documents
|
Copyright © 2021. All rights reserved.