com.veeva.vault.vapil.api.request

Class DomainRequest

java.lang.Object

com.veeva.vault.vapil.api.request.VaultRequest

com.veeva.vault.vapil.api.request.DomainRequest

public class DomainRequest
extends VaultRequest

Retrieve Domain specific information

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#domain-information

Field Summary

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

HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_VAULT_CLIENT_ID, vaultClient

Method Summary

Modifier and Type	Method and Description
DomainResponse	retrieveDomainInformation() Retrieve Domain Information
VaultResponse	retrieveDomains() Retrieve Domains
DomainRequest	setIncludeApplications(Boolean includeApplications) To include Vault application type information in the response, set includeApplications to true.

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

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

Methods inherited from class java.lang.Object

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

Method Detail

retrieveDomainInformation

public DomainResponse retrieveDomainInformation()

Retrieve Domain Information

Domain Admins can use this request to retrieve a list of all vaults currently in their domain.

Returns:

DomainResponse

Vault API Endpoint:

 GET /api/{version}/objects/domain

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-domain-information

Example Request:

 DomainResponse resp = vaultClient.newRequest(DomainRequest.class)
                .setIncludeApplications(includeApplication)
                .retrieveDomainInformation();

Example Response:

 System.out.println("Domain Name = " + resp.getDomain().getDomainName());
 System.out.println("Domain Type = " + resp.getDomain().getDomainType());

 for (DomainVault v : resp.getDomain().getVaults()) {
        System.out.println("Name = " + v.getVaultName() + ", Id = " + v.getId());
 }

retrieveDomains

public VaultResponse retrieveDomains()

Retrieve Domains

Retrieve a list of all vaults currently in their domain, including the domain of the current vault. This endpoint can be used for non-domain admins.

Returns:

DomainResponse

Vault API Endpoint:

 GET /api/{version}/objects/domains

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-domains

Example Request:

 DomainResponse resp = vaultClient.newRequest(DomainRequest.class)
                .retrieveDomains();

setIncludeApplications

public DomainRequest setIncludeApplications(Boolean includeApplications)

To include Vault application type information in the response, set includeApplications to true. If false, application information is not included.

Parameters:

includeApplications - Set to true to include application type information

Returns:

The request