Veeva Vault Ci Integration

Overview

Guidance for ci integration with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Common Errors

Overview

Guidance for common errors with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Core Workflow A

Overview

Guidance for core workflow a with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Core Workflow B

Overview

Guidance for core workflow b with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Cost Tuning

Overview

Guidance for cost tuning with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Data Handling

Overview

Enterprise-grade data handling patterns for Veeva Vault deployments.

Instructions

Key Considerations

• Veeva Vault is purpose-built for regulated life sciences
• All API changes should be validated against compliance requirements
• Use VQL for efficient data retrieval
• VAPIL provides Java-native API coverage

Error Handling

Resources

• Vault API Reference
• Vault Documentation

Next Steps

See related Veeva Vault skills.

Veeva Vault Debug Bundle

Overview

Guidance for debug bundle with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Deploy Integration

Overview

Guidance for deploy integration with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Enterprise Rbac

Overview

Enterprise-grade enterprise rbac patterns for Veeva Vault deployments.

Instructions

Key Considerations

• Veeva Vault is purpose-built for regulated life sciences
• All API changes should be validated against compliance requirements
• Use VQL for efficient data retrieval
• VAPIL provides Java-native API coverage

Error Handling

Resources

• Vault API Reference
• Vault Documentation

Next Steps

See related Veeva Vault skills.

Veeva Vault Hello World

Overview

Create, retrieve, and query documents in Veeva Vault -- the fundamental CRUD operations. Uses the Vault REST API with VQL (Vault Query Language) for data retrieval.

Instructions

Step 1: Query Documents with VQL

import requests, os

vault_url = "https://myvault.veevavault.com/api/v24.1"
headers = {"Authorization": session_id}

# VQL is SQL-like but Vault-specific
query = "SELECT id, name__v, type__v, status__v, created_date__v FROM documents LIMIT 10"
response = requests.post(f"{vault_url}/query", headers=headers, data={"q": query})
result = response.json()

for doc in result.get("data", []):
    print(f"{doc['name__v']} | Type: {doc['type__v']} | Status: {doc['status__v']}")

Step 2: Retrieve a Document

doc_id = 123
response = requests.get(f"{vault_url}/objects/documents/{doc_id}", headers=headers)
doc = response.json()
print(f"Document: {doc['document']['name__v']}")
print(f"Version: {doc['document']['major_version_number__v']}.{doc['document']['minor_version_number__v']}")

Step 3: Create a Document

# Create document metadata
doc_data = {
    "name__v": "Protocol Amendment 001",
    "type__v": "Trial Document",
    "subtype__v": "Protocol",
    "lifecycle__v": "General Lifecycle",
}
response = requests.post(f"{vault_url}/objects/documents", headers=headers, data=doc_data)
new_id = response.json()["id"]
print(f"Created document: {new_id}")

Step 4: Upload Document File

with open("protocol.pdf", "rb") as f:
    response = requests.post(
        f"{vault_url}/objects/documents/{new_id}/file",
        headers={**headers, "Content-Type": "application/octet-stream"},
        data=f,
    )
print(f"File uploaded: {response.json()['responseStatus']}")

Output

Protocol Amendment 001 | Type: Trial Document | Status: Draft
Document: Protocol Amendment 001
Version: 0.1
Created document: 456
File uploaded: SUCCESS

Error Handling

Reso

Veeva Vault Incident Runbook

Overview

Enterprise-grade incident runbook patterns for Veeva Vault deployments.

Instructions

Key Considerations

• Veeva Vault is purpose-built for regulated life sciences
• All API changes should be validated against compliance requirements
• Use VQL for efficient data retrieval
• VAPIL provides Java-native API coverage

Error Handling

Resources

• Vault API Reference
• Vault Documentation

Next Steps

See related Veeva Vault skills.

Veeva Vault Install & Auth

Overview

Authenticate with Veeva Vault REST API using session-based auth. Base URL: https://{vault}.veevavault.com/api/{version}/. All requests require a session ID obtained via username/password or OAuth 2.0.

Instructions

Step 1: Install VAPIL (Java) or HTTP Client

# Java (VAPIL - Vault API Library)
# Add to pom.xml or gradle
# https://github.com/veeva/vault-api-library

# Python/Node.js -- use HTTP client
pip install requests
# or
npm install axios

Step 2: Obtain Session ID

import requests

vault_url = "https://myvault.veevavault.com/api/v24.1"
auth_response = requests.post(f"{vault_url}/auth", data={
    "username": os.environ["VEEVA_USERNAME"],
    "password": os.environ["VEEVA_PASSWORD"],
})
session_id = auth_response.json()["sessionId"]
print(f"Session ID: {session_id[:20]}...")

Step 3: Make Authenticated Request

headers = {"Authorization": session_id}
response = requests.get(f"{vault_url}/metadata/objects", headers=headers)
print(f"Objects: {len(response.json()['objects'])}")

Step 4: VQL Query

query = "SELECT id, name__v, status__v FROM documents WHERE status__v = 'Approved'"
response = requests.post(f"{vault_url}/query", headers=headers, data={"q": query})
for doc in response.json().get("data", []):
    print(f"  {doc['name__v']} (ID: {doc['id']})")

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL Java SDK
• Developer Portal

Next Steps

Proceed to veeva-hello-world for document operations.

Veeva Vault Local Dev Loop

Overview

Guidance for local dev loop with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Migration Deep Dive

Overview

Enterprise-grade migration deep dive patterns for Veeva Vault deployments.

Instructions

Key Considerations

• Veeva Vault is purpose-built for regulated life sciences
• All API changes should be validated against compliance requirements
• Use VQL for efficient data retrieval
• VAPIL provides Java-native API coverage

Error Handling

Resources

• Vault API Reference
• Vault Documentation

Next Steps

See related Veeva Vault skills.

Veeva Vault Multi Env Setup

Overview

Enterprise-grade multi env setup patterns for Veeva Vault deployments.

Instructions

Key Considerations

• Veeva Vault is purpose-built for regulated life sciences
• All API changes should be validated against compliance requirements
• Use VQL for efficient data retrieval
• VAPIL provides Java-native API coverage

Error Handling

Resources

• Vault API Reference
• Vault Documentation

Next Steps

See related Veeva Vault skills.

Veeva Vault Observability

Overview

Enterprise-grade observability patterns for Veeva Vault deployments.

Instructions

Key Considerations

• Veeva Vault is purpose-built for regulated life sciences
• All API changes should be validated against compliance requirements
• Use VQL for efficient data retrieval
• VAPIL provides Java-native API coverage

Error Handling

Resources

• Vault API Reference
• Vault Documentation

Next Steps

See related Veeva Vault skills.

Veeva Vault Performance Tuning

Overview

Guidance for performance tuning with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Prod Checklist

Overview

Guidance for prod checklist with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Rate Limits

Overview

Guidance for rate limits with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Reference Architecture

Overview

Guidance for reference architecture with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Sdk Patterns

Overview

Guidance for sdk patterns with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Security Basics

Overview

Guidance for security basics with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Upgrade Migration

Overview

Guidance for upgrade migration with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.

Veeva Vault Webhooks Events

Overview

Guidance for webhooks events with Veeva Vault REST API, VQL queries, and VAPIL Java SDK.

Instructions

Key Vault API Concepts

• Authentication: Session-based (username/password or OAuth 2.0)
• Base URL: https://{vault}.veevavault.com/api/v24.1/
• VQL: SQL-like query language for Vault data
• VAPIL: Open-source Java SDK covering all Platform APIs
• Lifecycle: Documents flow through states (Draft > In Review > Approved)

Common VQL Patterns

-- List documents by type
SELECT id, name__v FROM documents WHERE type__v = 'Trial Document'

-- Find objects
SELECT id, name__v FROM site__v WHERE status__v = 'active__v'

-- Join related objects
SELECT id, name__v, study__vr.name__v FROM study_country__v

Error Handling

Resources

• Vault API Reference
• VQL Reference
• VAPIL SDK
• Developer Portal

Next Steps

See related Veeva Vault skills for more patterns.