Package com.veeva.vault.vapil.api.request

Class EDLRequest

java.lang.Object
com.veeva.vault.vapil.api.request.VaultRequest<EDLRequest>
com.veeva.vault.vapil.api.request.EDLRequest
public class EDLRequest extends VaultRequest<EDLRequest>
Expected Document Lists (EDLs) help you to measure the completeness of projects.
Vault API Coverage:
https://developer.veevavault.com/api/25.1/#expected-document-lists

  • Method Details

    • createPlaceholderFromEDLItem

      public JobCreateResponse createPlaceholderFromEDLItem(List<String> edlItemIds)
      Create a placeholder from an EDL item.
      Parameters:
      edlItemIds - list of edl item ids on which to initiate the action
      Returns:
      JobCreateResponse
      Vault API Endpoint:
       POST /api/{version}/vobjects/edl_item__v/actions/createplaceholder
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#create-a-placeholder-from-an-edl-item
      Example Request:
       JobCreateResponse resp = vaultClient.newRequest(EDLRequest.class)
                 .createPlaceholderFromEDLItem(edlItemIds);
      Example Response:
       System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("JobId = " + resp.getJobId());
   System.out.println("Url = " + resp.getUrl());

   if (resp.getWarnings() != null) {
     for (JobCreateResponse.Warning warning : resp.getWarnings()) {
              System.out.println("Type = " + warning.getMessage() + ", Message = " + warning.getMessage());
     }
   }
 }

    • retrieveAllRootNodes

      public EDLResponse retrieveAllRootNodes(EDLRequest.NodeType nodeType)
      Retrieves all root EDL nodes and node metadata
      Parameters:
      nodeType - The tree object type to retrieve
      Returns:
      EDLResponse
      Vault API Endpoint:
       GET /api/{version}/composites/trees/{edl_hierarchy_or_template}
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-all-root-nodes
      Example Request:
       List<EDLNode> resp = vaultClient.newRequest(EDLRequest.class)
 .retrieveAllRootNodes(EDLRequest.NodeType.TEMPLATE)
 .getData();
      Example Response:
       resp.forEach(node->System.out.println(node));

    • retrieveSpecificRootNodes

      public EDLResponse retrieveSpecificRootNodes(EDLRequest.NodeType nodeType, List<String> nodeRefIds)
      Retrieves the root node ID for the given EDL record IDs
      Parameters:
      nodeType - The tree object type to retrieve
      nodeRefIds - list of EDL reference IDs to select root node IDs
      Returns:
      EDLResponse
      Vault API Endpoint:
       GET /api/{version}/composites/trees/{edl_hierarchy_or_template}/actions/listnodes
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-specific-root-nodes
      Example Request:
       List<EDLNode> resp = vaultClient.newRequest(EDLRequest.class)
 .retrieveSpecificRootNodes(EDLRequest.NodeType.TEMPLATE)
 .getData();
      Example Response:
       resp.forEach(node->System.out.println(node));

    • retrieveNodeChildren

      public EDLResponse retrieveNodeChildren(EDLRequest.NodeType nodeType, String parentNodeId)
      Given an EDL node ID, retrieves immediate children (not grandchildren) of that node.
      Parameters:
      nodeType - The tree object type to retrieve
      parentNodeId - The Id of the Parent Node
      Returns:
      EDLResponse
      Vault API Endpoint:
       GET /api/{version}/composites/trees/edl_hierarchy__v/{parent_node_id}/children
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-a-node-s-children
      Example Request:
       List<EDLNode> resp = vaultClient.newRequest(EDLRequest.class)
 .retrieveNodeChildren(EDLRequest.NodeType.HIERARCHY, parent_node_id)
 .getData();
      Example Response:
       resp.forEach(node->System.out.println(node));

    • updateNodeOrder

      public VaultResponse updateNodeOrder(EDLRequest.NodeType nodeType, String parentNodeId)
      Given an EDL node ID, retrieves immediate children (not grandchildren) of that node. Content-Type application/json (default) or text/csv
      Parameters:
      nodeType - The tree object type to retrieve
      parentNodeId - The ID of a parent node in the hierarchy
      Returns:
      VaultResponse
      Vault API Endpoint:
       PUT /api/{version}/composites/trees/edl_hierarchy__v/{parent_node_id}/children
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#update-node-order
      Example Request:
       VaultResponse resp = vaultClient.newRequest(EDLRequest.class)
     .setContentTypeJson() or .setContentTypeCSV()
     .setInputPath(inputFilePath)
     .updateNodeOrder(EDLRequest.NodeType.TEMPLATE, parentNodeId);

    • addEdlMatchedDocuments

      public EDLMatchedDocumentResponse addEdlMatchedDocuments()
      Add matched documents to EDL Items. You must have a security profile that grants Application: EDL Matching: Edit Document Matches permission, and EDL Matched Document APIs must be enabled in your Vault.
      Returns:
      EDLMatchedDocumentResponse
      Vault API Endpoint:
       POST /api/{version}/objects/edl_matched_documents/batch/actions/add
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#add-edl-matched-documents
      Example Request:
       EDLMatchedDocumentResponse resp = vaultClient.newRequest(EDLRequest.class)
     .setContentTypeJson() or .setContentTypeCSV()
     .setInputPath(inputFilePath)
     .addEdlMatchedDocuments();

    • removeEdlMatchedDocuments

      public EDLMatchedDocumentResponse removeEdlMatchedDocuments()
      Remove manually matched documents from EDL Items. You must have a security profile that grants Application: EDL Matching: Edit Document Matches permission, and EDL Matched Document APIs must be enabled in your Vault.
      Returns:
      EDLMatchedDocumentResponse
      Vault API Endpoint:
       POST /api/{version}/objects/edl_matched_documents/batch/actions/remove
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#remove-edl-matched-documents
      Example Request:
       EDLMatchedDocumentResponse resp = vaultClient.newRequest(EDLRequest.class)
     .setContentTypeJson() or .setContentTypeCSV()
     .setInputPath(inputFilePath)
     .removeEdlMatchedDocuments();

    • setBinaryFile

      public EDLRequest 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 EDLRequest setContentTypeCsv()
      Set the Header Content Type to CSV
      Returns:
      The Request

    • setContentTypeJson

      public EDLRequest setContentTypeJson()
      Set the Header Content Type to JSON
      Returns:
      The Request

    • setAcceptCSV

      public EDLRequest setAcceptCSV()
      Set the Header Accept to return CSV
      Returns:
      The Request

    • setAcceptJson

      public EDLRequest setAcceptJson()
      Set the Header Accept to return CSV
      Returns:
      The Request

    • setInputPath

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