VaultApiClient

Provides functions to use Vault API from client code.

Properties

Section link for Properties

fetch

Section link for fetch

fetch: (input, init?) => Promise<Response>

Makes authorized requests to Vault API and prepends the /api prefix to the path. This is a wrapped version of JavaScript's fetch function.

Parameters

Section link for Parameters

input

Section link for input

string

A URL string to make a request to

init?

Section link for init?

RequestInit

A RequestInit object containing any custom settings that you want to apply to the request

Returns

Section link for Returns

Promise<Response>

A Promise which is fulfilled with a Response object representing the server's response

See

Section link for See

• https://limited.veevavault.dev/vault-api/api-reference
• https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch

Remarks

Section link for Remarks

Only accepts strings as input, not URL or Request objects.

Naively prepends /api to the provided URL. For example, calling this with "http://example.com" would make a request to "/api/http://example.com".

Example

Section link for Example

Copy to clipboard

import { vaultApiClient } from '@veeva/vault'

const response = await vaultApiClient.fetch(
      '/v25.1/objects/documents/301',
      {
        headers: {
          Accept: 'application/json',
        },
      }
    );
const json = response.json();