com.veeva.vault.vapil.api.request

Class DocumentRelationshipRequest

java.lang.Object

com.veeva.vault.vapil.api.request.VaultRequest<DocumentRelationshipRequest>

com.veeva.vault.vapil.api.request.DocumentRelationshipRequest

public class DocumentRelationshipRequest
extends VaultRequest<DocumentRelationshipRequest>

Document Relationship Requests

Vault API Coverage:

https://developer.veevavault.com/api/24.1/#document-relationships

Field Summary

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

HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_REFERENCE_ID, HTTP_HEADER_VAULT_CLIENT_ID, referenceId, vaultClient

Method Summary

Modifier and Type	Method and Description
DocumentRelationshipBulkResponse	createMultipleDocumentRelationships() Create Multiple Document Relationships Create new relationships on multiple documents.
DocumentRelationshipResponse	createSingleDocumentRelationship(int docId, int majorVersion, int minorVersion, DocumentRelationship relationship) Create Single Document Relationship Create a new relationship on a document.
DocumentRelationshipBulkResponse	deleteMultipleDocumentRelationships() Delete Multiple Document Relationships Delete a relationships from multiple documents.
DocumentRelationshipResponse	deleteSingleDocumentRelationship(int docId, int majorVersion, int minorVersion, int relationshipId) Delete Single Document Relationship Delete a relationship from a document.
DocumentRelationshipRetrieveResponse	retrieveDocumentRelationship(int docId, int majorVersion, int minorVersion, int relationshipId) Retrieve Document Relationship Retrieve details of a specific document relationship.
DocumentRelationshipRetrieveResponse	retrieveDocumentRelationships(int docId, int majorVersion, int minorVersion) Retrieve Document Relationships Retrieve all relationships from a document.
DocumentRelationshipMetadataResponse	retrieveDocumentTypeRelationships(String documentType) Retrieve Document Type Relationships Retrieve all relationships from a document type.
DocumentRelationshipRequest	setBinaryFile(String filename, byte[] binaryContent) Specify source data in an input file
DocumentRelationshipRequest	setContentTypeCsv() Set the Header Content Type to text/csv
DocumentRelationshipRequest	setContentTypeJson() Set the Header Content Type to application/json
DocumentRelationshipRequest	setContentTypeXForm() Set the Header Content Type to application/x-www-form-urlencoded
DocumentRelationshipRequest	setInputPath(String inputPath) Specify source data in an input file
DocumentRelationshipRequest	setRequestString(String requestString) Specify source data in an input string, such as a JSON request

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

getBaseObjectMapper, send, send, sendReturnBinary, sendReturnBinary, sendToFile, sendToFile, setHeaderReferenceId, setVaultClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

retrieveDocumentTypeRelationships

public DocumentRelationshipMetadataResponse retrieveDocumentTypeRelationships(String documentType)

Retrieve Document Type Relationships
Retrieve all relationships from a document type.

Parameters:

documentType - The document type

Returns:

DocumentRelationshipMetadataResponse

Vault API Endpoint:

 GET /api/{version}/metadata/objects/documents/types/{type}/relationships

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#retrieve-document-type-relationships

Example Request:

 DocumentRelationshipMetadataResponse response = vaultClient.newRequest(DocumentRelationshipRequest.class)
                                        .retrieveDocumentTypeRelationships(documentType);

Example Response:

 System.out.println(response.getResponse());

 if (response.isSuccessful()) {
   // Properties
   for (RelationshipProperty p : response.getProperties()) {
     System.out.println("\n**** Relationship Property **** ");
     System.out.println("Name = " + p.getName());
     System.out.println("Type = " + p.getType());
     System.out.println("Length = " + p.getLength());
     System.out.println("Editable = " + p.getEditable());
     System.out.println("Queryable = " + p.getQueryable());
     System.out.println("Required = " + p.getRequired());
     System.out.println("Multivalue = " + p.getMultivalue());
     System.out.println("onCreateEditable = " + p.getOnCreateEditable());
     }

   // Relationship Types
   for (RelationshipType t : response.getRelationshipTypes()) {
     System.out.println("\n**** Relationship Type **** ");
     System.out.println("Value = " + t.getValue());
     System.out.println("Label = " + t.getLabel());
     System.out.println("Source Doc Version Specific = " + t.getSourceDocVersionSpecific());
     System.out.println("Target Doc Version Specific = " + t.getTargetDocVersionSpecific());
     System.out.println("System = " + t.getSystem());
     System.out.println("Single User = " + t.getSingleUse());

     // Target Document Types
     for (TargetDocumentType data : t.getTargetDocumentTypes()) {
       System.out.println("\n**** Target Document Type **** ");
       System.out.println("Label = " + data.getLabel());
       System.out.println("Value = " + data.getValue());
       }
     }

   // Relationships
   for (Relationship r : response.getRelationships()) {
     System.out.println("\n**** Relationship Item **** ");
     System.out.println("Relationship Name = " + r.getRelationshipName());
     System.out.println("Relationship Label = " + r.getRelationshipLabel());
     System.out.println("Relationship Type = " + r.getRelationshipName());

     // Object
     System.out.println("Relationship Object Name = " + r.getRelationshipObject().getName());
     }
 }

retrieveDocumentRelationships

public DocumentRelationshipRetrieveResponse retrieveDocumentRelationships(int docId,
                                                                          int majorVersion,
                                                                          int minorVersion)

Retrieve Document Relationships
Retrieve all relationships from a document.

Parameters:

docId - The Document Id

majorVersion - The document major_version_number__v field value

minorVersion - The document minor_version_number__v field value

Returns:

DocumentRelationshipResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#retrieve-document-relationships

Example Request:

 DocumentRelationshipRetrieveResponse response = vaultClient.newRequest(DocumentRelationshipRequest.class)
                                .retrieveDocumentRelationships(docId, majorVersion, minorVersion);

Example Response:

 System.out.println(response.getResponse());

 if (response.isSuccessful()) {
   // Properties
   for (DocumentRelationshipRetrieveResponse.Relationship data : response.getRelationships()) {
     DocumentRelationship dr = data.getRelationship();
     System.out.println("\n**** Relationship **** ");
     System.out.println("Source Doc ID = " + dr.getSourceDocId());
     System.out.println("Relationship Type = " + dr.getRelationshipType());
     System.out.println("Created Date = " + dr.getCreatedDate());
     System.out.println("Relationship Id = " + dr.getId());
     System.out.println("Target Doc Id = " + dr.getTargetDocId());
     System.out.println("Created By = " + dr.getCreatedBy());
   }
 }

retrieveDocumentRelationship

public DocumentRelationshipRetrieveResponse retrieveDocumentRelationship(int docId,
                                                                         int majorVersion,
                                                                         int minorVersion,
                                                                         int relationshipId)

Retrieve Document Relationship
Retrieve details of a specific document relationship.

Parameters:

docId - The Document Id

majorVersion - The document major_version_number__v field value

minorVersion - The document minor_version_number__v field value

relationshipId - The relationship id field value

Returns:

DocumentRelationshipRetrieveResponse

Vault API Endpoint:

 GET /api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#retrieve-document-relationship

Example Request:

 DocumentRelationshipRetrieveResponse response = vaultClient.newRequest(DocumentRelationshipRequest.class)
                                .retrieveDocumentRelationship(docId, majorVersion, minorVersion, relationshipId);

Example Response:

 System.out.println(response.getResponse());

 if (response.isSuccessful()) {
   // Properties
   for (DocumentRelationshipRetrieveResponse.Relationship data : response.getRelationships()) {
     DocumentRelationship dr = data.getRelationship();
     System.out.println("\n**** Relationship **** ");
     System.out.println("Source Doc ID = " + dr.getSourceDocId());
     System.out.println("Relationship Type = " + dr.getRelationshipType());
     System.out.println("Created Date = " + dr.getCreatedDate());
     System.out.println("Id = " + dr.getId());
     System.out.println("Target Doc Id = " + dr.getTargetDocId());
     System.out.println("Created By = " + dr.getCreatedBy());
     }
 }

createSingleDocumentRelationship

public DocumentRelationshipResponse createSingleDocumentRelationship(int docId,
                                                                     int majorVersion,
                                                                     int minorVersion,
                                                                     DocumentRelationship relationship)

Create Single Document Relationship
Create a new relationship on a document.

Parameters:

docId - The Document Id

majorVersion - The document major_version_number__v field value

minorVersion - The document minor_version_number__v field value

relationship - The DocumentRelationship

Returns:

DocumentRelationshipResponse

Vault API Endpoint:

 POST /api/{version}/objects/documents/{document_id}/versions/{major_version_number__v}/{minor_version_number__v}/relationships

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#create-single-document-relationship

Example Request:

 DocumentRelationshipResponse response = vaultClient.newRequest(DocumentRelationshipRequest.class)
                                .createSingleDocumentRelationship(docId, majorVersion, minorVersion, docRelationship);

Example Response:

 if (response.isSuccessful()) {
   System.out.println("ResponseMessage = " + response.getResponseMessage());
   System.out.println("Id = " + response.getId());
 }

createMultipleDocumentRelationships

public DocumentRelationshipBulkResponse createMultipleDocumentRelationships()

Create Multiple Document Relationships
Create new relationships on multiple documents. The maximum input file size is 1GB. The values in the input must be UTF-8 encoded. CSVs must follow the standard format. The maximum batch size is 1000.

Returns:

DocumentRelationshipBulkResponse

Vault API Endpoint:

 POST /api/{version}/objects/documents/relationships/batch

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#create-multiple-document-relationships

deleteSingleDocumentRelationship

public DocumentRelationshipResponse deleteSingleDocumentRelationship(int docId,
                                                                     int majorVersion,
                                                                     int minorVersion,
                                                                     int relationshipId)

Delete Single Document Relationship
Delete a relationship from a document.

Parameters:

docId - The Document Id

majorVersion - The document major_version_number__v field value

minorVersion - The document minor_version_number__v field value

relationshipId - The relationship id field value

Returns:

DocumentRelationshipResponse

Vault API Endpoint:

 DELETE /api/{version}/objects/documents/{document_id}/versions/{major_version_number__v}/{minor_version_number__v}/relationships/{relationship_id}

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#delete-single-document-relationship

Example Request:

 DocumentRelationshipResponse response = vaultClient.newRequest(DocumentRelationshipRequest.class)
                                .deleteSingleDocumentRelationship(docId, majorVersion, minorVersion, relationshipId);

Example Response:

 if (response.isSuccessful()) {
   System.out.println("ResponseMessage = " + response.getResponseMessage());
   System.out.println("Id = " + response.getId());
 }

deleteMultipleDocumentRelationships

public DocumentRelationshipBulkResponse deleteMultipleDocumentRelationships()

Delete Multiple Document Relationships
Delete a relationships from multiple documents. The maximum input file size is 1GB. The values in the input must be UTF-8 encoded. CSVs must follow the standard format. The maximum batch size is 1000.

Returns:

DocumentRelationshipBulkResponse

Vault API Endpoint:

 DELETE /api/{version}/objects/documents/relationships/batch

Vault API Help Link:

https://developer.veevavault.com/api/24.1/#delete-multiple-document-relationships

setContentTypeCsv

public DocumentRelationshipRequest setContentTypeCsv()

Set the Header Content Type to text/csv

Returns:

The Request

setContentTypeJson

public DocumentRelationshipRequest setContentTypeJson()

Set the Header Content Type to application/json

Returns:

The Request

setContentTypeXForm

public DocumentRelationshipRequest setContentTypeXForm()

Set the Header Content Type to application/x-www-form-urlencoded

Returns:

The Request

setBinaryFile

public DocumentRelationshipRequest 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

setInputPath

public DocumentRelationshipRequest setInputPath(String inputPath)

Specify source data in an input file

Parameters:

inputPath - Absolute path to the file for the request

Returns:

The Request

setRequestString

public DocumentRelationshipRequest 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