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

Class LoaderRequest

java.lang.Object
com.veeva.vault.vapil.api.request.VaultRequest<LoaderRequest>
com.veeva.vault.vapil.api.request.LoaderRequest
public class LoaderRequest extends VaultRequest<LoaderRequest>
Vault Loader Requests
Vault API Coverage:
https://developer.veevavault.com/api/25.1/#vault-loader

  • Method Details

    • extractDataFiles

      public LoaderResponse extractDataFiles()
      Extract Data Files
      Returns:
      LoaderResponse
      Vault API Endpoint:
       POST /api/{version}/services/loader/extract
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#extract-data-files

    • loadDataObjects

      public LoaderResponse loadDataObjects()
      Load Data Objects
      Returns:
      LoaderResponse
      Vault API Endpoint:
       POST /api/{version}/services/loader/load
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#load-data-objects
      Example Request:
       List<LoaderTask> loaderTasks = new ArrayList<>();
 LoaderTask loaderTask = new LoaderTaskBuilder()
                .setAction(LoaderTaskBuilder.Action.CREATE)
                .setObjectType(LoaderTaskBuilder.ObjectType.OBJECTS)
                .setObject(OBJECT_NAME)
                .setFile(FILE_STAGING_LOADER_OBJECTS_CSV_PATH)
                .setRecordMigrationMode(true)
                .setNoTriggers(true)
                .build();
 loaderTasks.add(loaderTask);

 LoaderResponse response = vaultClient.newRequest(LoaderRequest.class)
                .addLoaderTasks(loaderTasks)
                .loadDataObjects();
      Example Response:
       System.out.println("Job Id: " + response.getJobId());
 for (LoaderTask task : response.getTasks()) {
                System.out.println("***Loader Task***");
                System.out.println("Task Id: " + task.getTaskId());
                System.out.println("Object Type: " + task.getObjectType());
 }

    • retrieveLoaderExtractResults

      public VaultResponse retrieveLoaderExtractResults(int jobId, int taskId)
      Retrieve Loader Extract Results
      Parameters:
      jobId - The Job Id
      taskId - The Task Id
      Returns:
      VaultResponse
      Vault API Endpoint:
       GET /api/{version}/services/loader/{job_id}/tasks/{task_id}/results
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-extract-results

    • retrieveLoaderExtractRenditionsResults

      public VaultResponse retrieveLoaderExtractRenditionsResults(int jobId, int taskId)
      Retrieve Loader Extract Renditions Results
      Parameters:
      jobId - The Job Id
      taskId - The Task Id
      Returns:
      VaultResponse
      Vault API Endpoint:
       GET /api/{version}/services/loader/{job_id}/tasks/{task_id}/results/renditions
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-loader-extract-renditions-results

    • retrieveLoadSuccessLogResults

      public VaultResponse retrieveLoadSuccessLogResults(int jobId, int taskId)
      Retrieve Load Success Log Results
      Parameters:
      jobId - The Job Id
      taskId - The Task Id
      Returns:
      VaultResponse
      Vault API Endpoint:
       GET /api/{version}/services/loader/{job_id}/tasks/{task_id}/successlog
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-load-success-log-results

    • retrieveLoadFailureLogResults

      public VaultResponse retrieveLoadFailureLogResults(int jobId, int taskId)
      Retrieve Load Success Log Results
      Parameters:
      jobId - The Job Id
      taskId - The Task Id
      Returns:
      VaultResponse
      Vault API Endpoint:
       GET /api/{version}/services/loader/{job_id}/tasks/{task_id}/failurelog
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-load-failure-log-results

    • setJson

      public LoaderRequest setJson(String json)
      Set a raw JSON string to the Vault Loader request
      Parameters:
      json - Fully formed Vault Loader request
      Returns:
      The Request

    • addLoaderTask

      public LoaderRequest addLoaderTask(LoaderTask loaderTask) throws Exception
      Add an individual Vault Loader Task to the request Throws IllegalArgumentException when maximum number of loader tasks is reached (10).
      Parameters:
      loaderTask - The Vault Loader Task to add
      Returns:
      The Request
      Throws:
      Exception - The exception

    • addLoaderTasks

      public LoaderRequest addLoaderTasks(List<LoaderTask> loaderTasks) throws Exception
      Add a full list of Vault Loader Tasks to the request Throws IllegalArgumentException when maximum number of loader tasks is reached (10).
      Parameters:
      loaderTasks - The Vault Loader Task to add
      Returns:
      The Request
      Throws:
      Exception - maximum number of loader tasks exceeded

    • setOutputPath

      public LoaderRequest setOutputPath(String outputPath)
      Specify source data in an output file
      Parameters:
      outputPath - Absolute path to the file for the response
      Returns:
      The Request

    • setSendNotification

      public LoaderRequest setSendNotification(Boolean sendNotification)
      To send a Vault notification when the job completes, set to true. If omitted, this defaults to false and Vault does not send a notification when the job completes.
      Parameters:
      sendNotification - send notification to user
      Returns:
      The Request