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

Class BulkTranslationRequest

java.lang.Object
com.veeva.vault.vapil.api.request.VaultRequest<BulkTranslationRequest>
com.veeva.vault.vapil.api.request.BulkTranslationRequest
public class BulkTranslationRequest extends VaultRequest<BulkTranslationRequest>
Bulk Translation Requests
  • Export Bulk Translation File
  • Import Bulk Translation File
  • Retrieve Import Bulk Translation File Job Summary
  • Retrieve Import Bulk Translation File Job Errors
Vault API Coverage:
https://developer.veevavault.com/api/25.1/#bulk-translation

  • Field Details

  • Constructor Details

    • BulkTranslationRequest

      public BulkTranslationRequest()

  • Method Details

    • exportBulkTranslationFile

      public BulkTranslationJobResponse exportBulkTranslationFile(BulkTranslationRequest.MESSAGE_TYPE messageType, String lang)
      Export Bulk Translation File

      Export a bulk translation file from your Vault. The exported bulk translation file is a CSV editable in any text editor or translation software. You can request one (1) message type in one (1) language per request.

      Parameters:
      messageType - The message type to export.
      lang - The language to export.
      Returns:
      BulkTranslationJobResponse
      Vault API Endpoint:
       POST /api/{version}/messages/{message_type}/language/{lang}/actions/export
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#export-bulk-translation-file
      Example Request:
       BulkTranslationJobResponse response = vaultClient.newRequest(BulkTranslationRequest.class)
                .exportBulkTranslationFile(MESSAGE_TYPE.SYSTEM_MESSAGES, "ja");
      Example Response:
       System.out.println("Job ID = " + response.getData().getJobId());
 System.out.println("Job Status = " + response.getData().getUrl());

    • importBulkTranslationFile

      public BulkTranslationJobResponse importBulkTranslationFile(BulkTranslationRequest.MESSAGE_TYPE messageType, String filePath)
      Import Bulk Translation File

      Import a bulk translation file into Vault. While an exported bulk translation file can contain only one (1) language, your import file may include multiple languages.

      Parameters:
      messageType - The message type to export.
      filePath - The file path of the CSV file on the file staging server.
      Returns:
      BulkTranslationJobResponse
      Vault API Endpoint:
       POST /api/{version}/messages/{message_type}/actions/import
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#import-bulk-translation-file
      Example Request:
       BulkTranslationJobResponse response = vaultClient.newRequest(BulkTranslationRequest.class)
                .importBulkTranslationFile(MESSAGE_TYPE.SYSTEM_MESSAGES, "/bulk_translation_test.csv");
      Example Response:
       System.out.println("Job ID = " + response.getData().getJobId());
 System.out.println("Job URL = " + response.getData().getUrl());

    • retrieveImportBulkTranslationFileJobSummary

      public BulkTranslationImportSummaryResponse retrieveImportBulkTranslationFileJobSummary(String jobId)
      Retrieve Import Bulk Translation File Job Summary

      After submitting a request to import a bulk translation file, you can query Vault to determine the results of the request.

      Parameters:
      jobId - The job ID of the import bulk translation file job.
      Returns:
      BulkTranslationImportSummaryResponse
      Vault API Endpoint:
       GET /api/{version}/services/jobs/{job_id}/summary
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-import-bulk-translation-file-job-summary
      Example Request:
       BulkTranslationImportSummaryResponse response = vaultClient.newRequest(BulkTranslationRequest.class)
                .retrieveImportBulkTranslationFileJobSummary(jobId);
      Example Response:
       System.out.println("Ignored = " + response.getData().getIgnored());
 System.out.println("Updated = " + response.getData().getUpdated());
 System.out.println("Failed = " + response.getData().getFailed());
 System.out.println("Added = " + response.getData().getAdded());

    • retrieveImportBulkTranslationFileJobErrors

      public VaultResponse retrieveImportBulkTranslationFileJobErrors(String jobId)
      Retrieve Import Bulk Translation File Job Errors

      After submitting a request to import a bulk translation file, you can query Vault to determine the errors from the request (if any).

      Parameters:
      jobId - The job ID of the import bulk translation file job.
      Returns:
      VaultResponse
      Vault API Endpoint:
      GET /api/{version}/services/jobs/{job_id}/errors
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-import-bulk-translation-file-job-errors
      Example Request:
       VaultResponse response = vaultClient.newRequest(BulkTranslationRequest.class)
                .retrieveImportBulkTranslationFileJobErrors(jobId);
      Example Response:
       String text = new String(response.getBinaryContent(), StandardCharsets.UTF_16);
 System.out.println(text);