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

Class CustomPagesRequest

java.lang.Object
com.veeva.vault.vapil.api.request.VaultRequest<CustomPagesRequest>
com.veeva.vault.vapil.api.request.CustomPagesRequest
public class CustomPagesRequest extends VaultRequest<CustomPagesRequest>
Direct Data Requests
  • Retrieve All Client Code Distribution Metadata
  • Retrieve Single Client Code Distribution Metadata
  • Download Single Client Code Distribution
  • Add or Replace Single Client Code Distribution
  • Delete Single Client Code Distribution
Vault API Coverage:
https://developer.veevavault.com/api/25.1/#direct-data

  • Field Details

  • Method Details

    • retrieveAllClientCodeDistributionMetadata

      public CustomPagesDistributionBulkResponse retrieveAllClientCodeDistributionMetadata()
      Retrieve All Client Code Distribution Metadata

      Retrieves a list of all client code distributions in the Vault and their metadata.

      Returns:
      CustomPagesDistributionBulkResponse
      Vault API Endpoint:
       GET /api/{version}/uicode/distributions
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-all-client-code-distribution-metadata
      Example Request:
       CustomPagesDistributionBulkResponse response = vaultClient.newRequest(CustomPagesRequest.class)
                .retrieveAllClientCodeDistributionMetadata();
      Example Response:
       for (ClientCodeDistribution dist : response.getData()) {
                System.out.println("--------Distribution---------");
                System.out.println("Name: " + dist.getName());
                System.out.println("Size: " + dist.getSize());
                System.out.println("Checksum: " + dist.getChecksum());
 }

    • retrieveSingleClientCodeDistributionMetadata

      public CustomPagesDistributionRetrieveResponse retrieveSingleClientCodeDistributionMetadata(String distributionName)
      Retrieve Single Client Code Distribution Metadata

      Retrieve metadata for a specific client code distribution, including its name and size.

      Parameters:
      distributionName - The name attribute of the client code distribution to retrieve.
      Returns:
      CustomPagesDistributionRetrieveResponse
      Vault API Endpoint:
       GET /api/{version}/uicode/distributions/{distribution_name}
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-single-client-code-distribution-metadata
      Example Request:
       CustomPagesDistributionRetrieveResponse response = vaultClient.newRequest(CustomPagesRequest.class)
                .retrieveSingleClientCodeDistributionMetadata(distributionName);
      Example Response:
       System.out.println("Distribution Name: " + response.getData().getName());
 System.out.println("Size: " + response.getData().getSize());
 System.out.println("Checksum: " + response.getData().getChecksum());

    • downloadSingleClientCodeDistribution

      public VaultResponse downloadSingleClientCodeDistribution(String distributionName)
      Download Single Client Code Distribution

      Download a ZIP file containing the client code distribution directory, including the client code files and the distribution manifest

      Parameters:
      distributionName - The name attribute of the client code distribution to download.
      Returns:
      VaultResponse
      Vault API Endpoint:
       GET /api/{version}/uicode/distributions/{distribution_name}/code
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#download-single-client-code-distribution
      Example Request:
       Example 1 - Binary
 VaultResponse response = vaultClient.newRequest(CustomPagesRequest.class)
                .downloadSingleClientCodeDistribution(distributionName);

 Example 2 - To File
 VaultResponse response = vaultClient.newRequest(CustomPagesRequest.class)
                .setOutputPath(outputPath)
                .downloadSingleClientCodeDistribution(distributionName);
      Example Response:
       Example 1 - Binary
 System.out.println("Response Status: " + response.getResponseStatus());
 byte[] fileContent = response.getBinaryContent();

 Example 2 - To File
 System.out.println("Response Status: " + response.getResponseStatus());
 System.out.println("Output Path: " + response.getOutputFilePath());

    • addOrReplaceSingleClientCodeDistribution

      public CustomPagesDistributionResponse addOrReplaceSingleClientCodeDistribution()
      Add or Replace Single Client Code Distribution

      Add or replace client code in Vault by uploading a ZIP file of the client code distribution. Vault unpacks and compares the uploaded distribution with other distributions in the Vault

      Returns:
      CustomPagesDistributionResponse
      Vault API Endpoint:
       POST /api/{version}/uicode/distributions/
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#add-or-replace-single-client-code-distribution
      Example Request:
       Example 1 - CSV input
 CustomPagesDistributionResponse response = vaultClient.newRequest(CustomPagesRequest.class)
                .setInputPath(inputPath)
                .addOrReplaceSingleClientCodeDistribution();

 Example 2 - Binary input
 File inputFile = new File(inputPath);
 byte[] fileContent = Files.readAllBytes(inputFile.toPath());
 response = vaultClient.newRequest(CustomPagesRequest.class)
                .setFile("vapil_test_dist.zip", fileContent)
                .addOrReplaceSingleClientCodeDistribution();
      Example Response:
       System.out.println("Distribution Name: " + response.getData().getName());
 System.out.println("Update Type: " + response.getData().getUpdateType());
 System.out.println("Checksum: " + response.getData().getChecksum());

    • deleteSingleClientCodeDistribution

      public VaultResponse deleteSingleClientCodeDistribution(String distributionName)
      Delete Single Client Code Distribution

      Delete a specific client code distribution. To delete a distribution, you must first remove all Page components associated with it from your Vault.

      Parameters:
      distributionName - The name attribute of the client code distribution to delete.
      Returns:
      VaultResponse
      Vault API Endpoint:
       DELETE /api/{version}/uicode/distributions/{distribution_name}
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#delete-single-client-code-distribution
      Example Request:
       VaultResponse response = vaultClient.newRequest(CustomPagesRequest.class)
                .deleteSingleClientCodeDistribution(distName);
      Example Response:
       System.out.println("Response Status: " + response.getResponseStatus());

    • setFile

      public CustomPagesRequest setFile(String filename, byte[] fileContent)
      Specify source data in an input file
      Parameters:
      filename - file name (no path)
      fileContent - byte array of the file content
      Returns:
      The Request

    • setInputPath

      public CustomPagesRequest 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 CustomPagesRequest setOutputPath(String outputPath)
      Specify source data in an output file
      Parameters:
      outputPath - Absolute path to the file for the response
      Returns:
      The Request