DocumentAttachmentRequest (Vault-API-Library 21.1.3 API)

java.lang.Object
- com.veeva.vault.vapil.api.request.VaultRequest
- - com.veeva.vault.vapil.api.request.DocumentAttachmentRequest

```
public class DocumentAttachmentRequest
extends VaultRequest
```
Document Attachment requests

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#document-attachments

Field Summary
- Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest
  HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_VAULT_CLIENT_ID, vaultClient

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentAttachmentResponse`	`createDocumentAttachment(int docId)` Create Document Attachment
`DocumentAttachmentBulkResponse`	`createMultipleDocumentAttachments()` Create Multiple Document Attachments
`DocumentAttachmentBulkResponse`	`deleteMultipleDocumentAttachments()` Delete Multiple Document Attachments
`VaultResponse`	`deleteSingleDocumentAttachment(int docId, int attachmentId)` Delete Single Document Attachment
`VaultResponse`	`deleteSingleDocumentAttachmentVersion(int docId, int attachmentId, int attachmentVersion)` Delete Single Document Attachment Version
`VaultResponse`	`downloadAllDocumentAttachments(int docId)` Download All Document Attachments
`VaultResponse`	`downloadAllDocumentVersionAttachments(int docId, int majorVersionNumber, int minorVersionNumber)` Download All Document Version Attachments
`VaultResponse`	`downloadDocumentAttachment(int docId, int attachmentId)` Download Document Attachment
`VaultResponse`	`downloadDocumentAttachmentVersion(int docId, int attachmentId, int attachVersionId)` Download Document Attachment Version
`VaultResponse`	`downloadDocumentVersionAttachment(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId)` Download Document Version Attachment
`VaultResponse`	`downloadDocumentVersionAttachmentVersion(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId, int attachVersionId)` Download Document Version Attachment Version
`DocumentAttachmentResponse`	`restoreDocumentAttachmentVersion(int docId, int attachmentId, int attachVersionId)` Restore Document Attachment Version Restores the specific version of an existing attachment to make it the latest version
`DocumentAttachmentResponse`	`retrieveDocumentAttachmentMetadata(int docId, int attachmentId)` Retrieve Document Attachment Metadata
`DocumentAttachmentResponse`	`retrieveDocumentAttachments(int docId)` Retrieve Document Attachments
`DocumentAttachmentResponse`	`retrieveDocumentAttachmentVersionMetadata(int docId, int attachmentId, int attachVersionId)` Retrieve Document Attachment Version Metadata
`DocumentAttachmentResponse`	`retrieveDocumentAttachmentVersions(int docId, int attachmentId)` Retrieve Document Attachment Versions
`DocumentAttachmentResponse`	`retrieveDocumentVersionAttachmentMetadata(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId)` Retrieve Document Version Attachment Metadata
`DocumentAttachmentResponse`	`retrieveDocumentVersionAttachments(int docId, int majorVersionNumber, int minorVersionNumber)` Retrieve Document Version Attachments
`DocumentAttachmentResponse`	`retrieveDocumentVersionAttachmentVersionMetadata(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId, int attachVersionId)` Retrieve Document Version Attachment Version Metadata
`DocumentAttachmentResponse`	`retrieveDocumentVersionAttachmentVersions(int docId, int majorVersionNumber, int minorVersionNumber, int attachmentId)` Retrieve Document Version Attachment Versions
`DocumentAttachmentRequest`	`setBinaryFile(String filename, byte[] binaryContent)` Specify source data in an input file
`DocumentAttachmentRequest`	`setContentTypeCsv()` Set the Header Content Type to CSV
`DocumentAttachmentRequest`	`setContentTypeJson()` Set the Header Content Type to JSON
`DocumentAttachmentRequest`	`setInputPath(String inputPath)` Specify source data in an input file
`DocumentAttachmentRequest`	`setOutputPath(String outputPath)` Specify source data in an output file
`DocumentAttachmentRequest`	`setRequestString(String requestString)` Specify source data in an input string, such as a JSON request
`VaultResponse`	`updateDocumentAttachmentDescription(int docId, int attachmentId, String description)` Update Document Attachment Description
`DocumentAttachmentBulkResponse`	`updateMultipleDocumentAttachmentDescriptions()` Update Multiple Document Attachment Descriptions

Methods inherited from class com.veeva.vault.vapil.api.request.VaultRequest
getBaseObjectMapper, send, send, sendReturnBinary, sendReturnBinary, sendToFile, sendToFile, setVaultClient

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - retrieveDocumentAttachments
```
public DocumentAttachmentResponse retrieveDocumentAttachments(int docId)
```
    Retrieve Document Attachments
    Parameters:
    
    docId - document id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/attachments
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#retrieve-document-attachments
  - retrieveDocumentVersionAttachments
```
public DocumentAttachmentResponse retrieveDocumentVersionAttachments(int docId,
                                                                     int majorVersionNumber,
                                                                     int minorVersionNumber)
```
    Retrieve Document Version Attachments
    Parameters:
    
    docId - document id
    
    majorVersionNumber - major version number
    
    minorVersionNumber - minor version number
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#retrieve-document-version-attachments
  - retrieveDocumentAttachmentVersions
```
public DocumentAttachmentResponse retrieveDocumentAttachmentVersions(int docId,
                                                                     int attachmentId)
```
    Retrieve Document Attachment Versions
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}/versions
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#retrieve-document-attachment-versions
  - retrieveDocumentVersionAttachmentVersions
```
public DocumentAttachmentResponse retrieveDocumentVersionAttachmentVersions(int docId,
                                                                            int majorVersionNumber,
                                                                            int minorVersionNumber,
                                                                            int attachmentId)
```
    Retrieve Document Version Attachment Versions
    Retrieve attachment versions on a specific version of a document.
    Parameters:
    
    docId - document id
    
    majorVersionNumber - major version number
    
    minorVersionNumber - minor version number
    
    attachmentId - attachment id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#retrieve-document-version-attachments-versions
  - retrieveDocumentAttachmentMetadata
```
public DocumentAttachmentResponse retrieveDocumentAttachmentMetadata(int docId,
                                                                     int attachmentId)
```
    Retrieve Document Attachment Metadata
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#retrieve-document-attachment-metadata
  - retrieveDocumentVersionAttachmentMetadata
```
public DocumentAttachmentResponse retrieveDocumentVersionAttachmentMetadata(int docId,
                                                                            int majorVersionNumber,
                                                                            int minorVersionNumber,
                                                                            int attachmentId)
```
    Retrieve Document Version Attachment Metadata
    Parameters:
    
    docId - document id
    
    majorVersionNumber - major version number
    
    minorVersionNumber - minor version number
    
    attachmentId - attachment id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}
    Vault API Help Link:
    
    (Undocumented Endpoint)
  - retrieveDocumentAttachmentVersionMetadata
```
public DocumentAttachmentResponse retrieveDocumentAttachmentVersionMetadata(int docId,
                                                                            int attachmentId,
                                                                            int attachVersionId)
```
    Retrieve Document Attachment Version Metadata
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    attachVersionId - attachment version id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#retrieve-document-attachment-version-metadata
  - retrieveDocumentVersionAttachmentVersionMetadata
```
public DocumentAttachmentResponse retrieveDocumentVersionAttachmentVersionMetadata(int docId,
                                                                                   int majorVersionNumber,
                                                                                   int minorVersionNumber,
                                                                                   int attachmentId,
                                                                                   int attachVersionId)
```
    Retrieve Document Version Attachment Version Metadata
    Parameters:
    
    docId - document id
    
    majorVersionNumber - major version number
    
    minorVersionNumber - minor version number
    
    attachmentId - attachment id
    
    attachVersionId - attachment version id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version}
    Vault API Help Link:
    
    (Undocumented Endpoint)
  - downloadDocumentAttachment
```
public VaultResponse downloadDocumentAttachment(int docId,
                                                int attachmentId)
```
    Download Document Attachment
    Downloads the latest version of the specified attachment from the document.
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}/file
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#download-document-attachment
  - downloadDocumentVersionAttachment
```
public VaultResponse downloadDocumentVersionAttachment(int docId,
                                                       int majorVersionNumber,
                                                       int minorVersionNumber,
                                                       int attachmentId)
```
    Download Document Version Attachment
    Downloads the latest version of the specified attachment from the document version
    Parameters:
    
    docId - document id
    
    majorVersionNumber - major version number
    
    minorVersionNumber - minor version number
    
    attachmentId - attachment id
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/file
    Vault API Help Link:
    
    (Undocumented Endpoint)
  - downloadDocumentAttachmentVersion
```
public VaultResponse downloadDocumentAttachmentVersion(int docId,
                                                       int attachmentId,
                                                       int attachVersionId)
```
    Download Document Attachment Version
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    attachVersionId - attachment version id
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}/file
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#download-document-attachment-version
  - downloadDocumentVersionAttachmentVersion
```
public VaultResponse downloadDocumentVersionAttachmentVersion(int docId,
                                                              int majorVersionNumber,
                                                              int minorVersionNumber,
                                                              int attachmentId,
                                                              int attachVersionId)
```
    Download Document Version Attachment Version
    Parameters:
    
    docId - document id
    
    majorVersionNumber - major version number
    
    minorVersionNumber - minor version number
    
    attachmentId - attachment id
    
    attachVersionId - attachment version id
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version}/file
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#download-document-version-attachment-version
  - downloadAllDocumentAttachments
```
public VaultResponse downloadAllDocumentAttachments(int docId)
```
    Download All Document Attachments
    Parameters:
    
    docId - document id
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/attachments/file
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#download-all-document-attachments
  - downloadAllDocumentVersionAttachments
```
public VaultResponse downloadAllDocumentVersionAttachments(int docId,
                                                           int majorVersionNumber,
                                                           int minorVersionNumber)
```
    Download All Document Version Attachments
    Parameters:
    
    docId - document id
    
    majorVersionNumber - major version number
    
    minorVersionNumber - minor version number
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    GET /api/{version}/objects/documents/{doc_id}/{major_version}/{minor_version}/attachments/file
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#download-all-document-version-attachments
  - deleteSingleDocumentAttachment
```
public VaultResponse deleteSingleDocumentAttachment(int docId,
                                                    int attachmentId)
```
    Delete Single Document Attachment
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    DELETE /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#delete-single-document-attachment
  - deleteSingleDocumentAttachmentVersion
```
public VaultResponse deleteSingleDocumentAttachmentVersion(int docId,
                                                           int attachmentId,
                                                           int attachmentVersion)
```
    Delete Single Document Attachment Version
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    attachmentVersion - version of the attachment
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    DELETE /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#delete-single-document-attachment-version
  - deleteMultipleDocumentAttachments
```
public DocumentAttachmentBulkResponse deleteMultipleDocumentAttachments()
```
    Delete Multiple Document Attachments
    This works for version-specific attachments and attachments at the document level.
    Returns:
    
    DocumentAttachmentBulkResponse
    
    Vault API Endpoint:
    DELETE /api/{version}/objects/documents/attachments/batch
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#delete-multiple-document-attachments
  - createDocumentAttachment
```
public DocumentAttachmentResponse createDocumentAttachment(int docId)
```
    Create Document Attachment
    Create an attachment on the latest version of a document. If the attachment already exists, Vault uploads the attachment as a new version of the existing attachment.
    Parameters:
    
    docId - document id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    POST /api/{version}/objects/documents/{doc_id}/attachments
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#create-document-attachment
  - createMultipleDocumentAttachments
```
public DocumentAttachmentBulkResponse createMultipleDocumentAttachments()
```
    Create Multiple Document Attachments
    Create multiple document attachments in bulk with a JSON or CSV input file. You must first load the attachments to the FTP staging server. This works for version-specific attachments and attachments at the document level. If the attachment already exists, Vault uploads the attachment as a new version of the existing attachment. Learn more about attachment versioning in Vault Help.
    Returns:
    
    DocumentAttachmentBulkResponse
    
    Vault API Endpoint:
    POST /api/{version}/objects/documents/attachments/batch
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#create-multiple-document-attachments
  - restoreDocumentAttachmentVersion
```
public DocumentAttachmentResponse restoreDocumentAttachmentVersion(int docId,
                                                                   int attachmentId,
                                                                   int attachVersionId)
```
    Restore Document Attachment Version Restores the specific version of an existing attachment to make it the latest version
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    attachVersionId - attachment version id
    
    Returns:
    
    DocumentAttachmentResponse
    
    Vault API Endpoint:
    POST /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#restore-document-attachment-version
  - updateDocumentAttachmentDescription
```
public VaultResponse updateDocumentAttachmentDescription(int docId,
                                                         int attachmentId,
                                                         String description)
```
    Update Document Attachment Description
    Parameters:
    
    docId - document id
    
    attachmentId - attachment id
    
    description - description of the attachment
    
    Returns:
    
    VaultResponse
    
    Vault API Endpoint:
    PUT /api/{version}/objects/documents/{doc_id}/attachments/{attachment_id}
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#update-document-attachment-description
  - updateMultipleDocumentAttachmentDescriptions
```
public DocumentAttachmentBulkResponse updateMultipleDocumentAttachmentDescriptions()
```
    Update Multiple Document Attachment Descriptions
    Update multiple document attachments in bulk with a JSON or CSV input file. This works for version-specific attachments and attachments at the document level. You can only update the latest version of an attachment.
    Returns:
    
    DocumentAttachmentBulkResponse
    
    Vault API Endpoint:
    PUT /api/{version}/objects/documents/attachments/batch
    Vault API Help Link:
    
    https://developer.veevavault.com/api/21.1/#update-multiple-document-attachment-descriptions
  - setBinaryFile
```
public DocumentAttachmentRequest setBinaryFile(String filename,
                                               byte[] binaryContent)
```
    Specify source data in an input file
    
    Parameters:
    
    filename - file name (no path)
    
    binaryContent - byte array of the file content
    
    Returns:
    
    The Request
  - setContentTypeCsv
```
public DocumentAttachmentRequest setContentTypeCsv()
```
    Set the Header Content Type to CSV
    
    Returns:
    
    The Request
  - setContentTypeJson
```
public DocumentAttachmentRequest setContentTypeJson()
```
    Set the Header Content Type to JSON
    
    Returns:
    
    The Request
  - setInputPath
```
public DocumentAttachmentRequest setInputPath(String inputPath)
```
    Specify source data in an input file
    
    Parameters:
    
    inputPath - Absolute path to the file for the request
    
    Returns:
    
    The Request
  - setOutputPath
```
public DocumentAttachmentRequest setOutputPath(String outputPath)
```
    Specify source data in an output file
    
    Parameters:
    
    outputPath - Absolute path to the file for the response
    
    Returns:
    
    The Request
  - setRequestString
```
public DocumentAttachmentRequest setRequestString(String requestString)
```
    Specify source data in an input string, such as a JSON request
    
    Parameters:
    
    requestString - The source request as a string
    
    Returns:
    
    The Request

Class DocumentAttachmentRequest

Field Summary

Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest

Method Summary

Methods inherited from class com.veeva.vault.vapil.api.request.VaultRequest

Methods inherited from class java.lang.Object

Method Detail

retrieveDocumentAttachments

retrieveDocumentVersionAttachments

retrieveDocumentAttachmentVersions

retrieveDocumentVersionAttachmentVersions

retrieveDocumentAttachmentMetadata

retrieveDocumentVersionAttachmentMetadata

retrieveDocumentAttachmentVersionMetadata

retrieveDocumentVersionAttachmentVersionMetadata

downloadDocumentAttachment

downloadDocumentVersionAttachment

downloadDocumentAttachmentVersion

downloadDocumentVersionAttachmentVersion

downloadAllDocumentAttachments

downloadAllDocumentVersionAttachments

deleteSingleDocumentAttachment

deleteSingleDocumentAttachmentVersion

deleteMultipleDocumentAttachments

createDocumentAttachment

createMultipleDocumentAttachments

restoreDocumentAttachmentVersion

updateDocumentAttachmentDescription

updateMultipleDocumentAttachmentDescriptions

setBinaryFile

setContentTypeCsv

setContentTypeJson

setInputPath

setOutputPath

setRequestString