com.veeva.vault.vapil.api.request

Class SandboxRequest

java.lang.Object

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

com.veeva.vault.vapil.api.request.SandboxRequest

public class SandboxRequest
extends VaultRequest

Sandbox Vaults

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#sandbox-vaults

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SandboxRequest.ReleaseType The type of release.

Field Summary

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

HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_VAULT_CLIENT_ID, vaultClient

Constructor Summary

Constructors

Constructor and Description
SandboxRequest()

Method Summary

Modifier and Type	Method and Description
JobCreateResponse	createOrRefreshSandbox(String type, String domain, String name) Create a new sandbox for the currently authenticated vault.
VaultResponse	deleteSandbox(String name) Delete a sandbox vault.
SandboxEntitlementResponse	retrieveSandboxEntitlements() Retrieve Sandbox Entitlements
SandboxResponse	retrieveSandboxes() Retrieve Sandboxes
SandboxResponse	retrieveSandboxsDetailsById(int vaultId) Retrieve Sandbox Details by ID
SandboxRequest	setAddRequester(Boolean addRequester) Set the AddRequester for createOrRefreshSandbox
SandboxRequest	setRelease(SandboxRequest.ReleaseType release) Set the release type for createOrRefreshSandbox
SandboxResponse	setSandboxEntitlements(String name, String type, int allowance, boolean grant, int temporaryAllowance) Set Sandbox Entitlements

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

Constructor Detail

SandboxRequest

public SandboxRequest()

Method Detail

retrieveSandboxes

public SandboxResponse retrieveSandboxes()

Retrieve Sandboxes

Retrieve information about the sandbox vaults for the authenticated vault.

Returns:

SandboxResponse

Vault API Endpoint:

 GET /api/{version}/objects/sandbox

Vault API Help Link:

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

retrieveSandboxsDetailsById

public SandboxResponse retrieveSandboxsDetailsById(int vaultId)

Retrieve Sandbox Details by ID

Retrieve information about the sandbox for the given vault ID.

Parameters:

vaultId - vault id

Returns:

SandboxResponse

Vault API Endpoint:

 GET /api/{version}/objects/sandbox/{vault_id}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#retrieve-sandbox-details-by-id

retrieveSandboxEntitlements

public SandboxEntitlementResponse retrieveSandboxEntitlements()

Retrieve Sandbox Entitlements

Retrieve the total number of available and number of in-use sandbox vaults for the authenticated vault.

Returns:

SandboxEntitlementResponse

Vault API Endpoint:

 GET /api/{version}/objects/sandbox_entitlements

Vault API Help Link:

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

setSandboxEntitlements

public SandboxResponse setSandboxEntitlements(String name,
                                              String type,
                                              int allowance,
                                              boolean grant,
                                              int temporaryAllowance)

Set Sandbox Entitlements

Set new sandbox entitlements, including granting and revoking allowances, for the given sandbox name.

Parameters:

name - The name of the sandbox vault, which appears on the My Vaults page

type - The type of sandbox. At this time, the only available type is config.

allowance - The number of entitlements to grant or revoke.

grant - Allowed values true and false. True grants allowances and false revokes them.

temporaryAllowance - The number of temporary sandbox allowances to grant or revoke.

Returns:

SandboxResponse

Vault API Endpoint:

 POST /api/{version}/objects/sandbox/entitlements/set

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#set-sandbox-entitlements

createOrRefreshSandbox

public JobCreateResponse createOrRefreshSandbox(String type,
                                                String domain,
                                                String name)

Create a new sandbox for the currently authenticated vault. Providing a name which already exists will refresh the existing sandbox vault.

Parameters:

type - The type of sandbox, such as config.

domain - The domain to use for the new sandbox.

name - The name of the sandbox vault, which appears on the My Vaults page.

Returns:

JobCreateResponse

Vault API Endpoint:

 POST /api/{version}/objects/sandbox

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#create-or-refresh-sandbox

deleteSandbox

public VaultResponse deleteSandbox(String name)

Delete a sandbox vault. Note that you cannot delete a sandbox which was created or refreshed within the last 24 hours.

Parameters:

name - The name of the sandbox vault to delete. This is the name which appears on the My Vaults page.

Returns:

VaultResponse

Vault API Endpoint:

 DELETE /api/{version}/objects/sandbox/{name}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#delete-sandbox

setAddRequester

public SandboxRequest setAddRequester(Boolean addRequester)

Set the AddRequester for createOrRefreshSandbox

Parameters:

addRequester - addRequester

Returns:

SandboxRequest

setRelease

public SandboxRequest setRelease(SandboxRequest.ReleaseType release)

Set the release type for createOrRefreshSandbox

Parameters:

release - release

Returns:

SandboxRequest