Planview Enterprise Architecture Python API Docs | dltHub
Build a Planview Enterprise Architecture-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
Planview Portfolios is a project portfolio management platform that provides a REST API for accessing data regarding portfolios, projects, and work items. The REST API base URL is https://{your_account}.pvcloud.com/{your_server}/public-api/v1 and all requests require a Bearer token.
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Planview Enterprise Architecture data in under 10 minutes.
What data can I load from Planview Enterprise Architecture?
Here are some of the endpoints you can load from Planview Enterprise Architecture:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| resources | /resources | GET | data | Retrieve a list of enterprise architecture resources |
| applications | /applications | GET | data | Retrieve application portfolio data |
| technologies | /technologies | GET | data | Retrieve technology standards and lifecycles |
| capabilities | /capabilities | GET | data | Retrieve business capabilities |
| dependencies | /dependencies | GET | data | Retrieve architectural dependency mappings |
How do I authenticate with the Planview Enterprise Architecture API?
All requests require an OAuth2 access token or API token passed in the Authorization header using the format 'Bearer {token}'.
1. Get your credentials
- Log in to your Planview Success Center or instance dashboard as an administrator. 2. Navigate to the Administration menu (often under Users or API Access sections). 3. Locate the API/OAuth settings tab (e.g., API Access, OAuth Clients, or My API Tokens). 4. Click 'Create New Token' or 'Create OAuth Client'. 5. Provide a name and assign necessary scopes/permissions. 6. Copy the generated API Token or Client ID/Secret immediately, as they are often only displayed once. Store these securely, such as in an environment variable or a vault system.
2. Add them to .dlt/secrets.toml
[sources.planview_enterprise_architecture_source] api_key = "your_api_token_here" # OR, if using OAuth flow: client_id = "your_client_id_here" client_secret = "your_client_secret_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI harness:
dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlthub ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Planview Enterprise Architecture API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python planview_enterprise_architecture_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline planview_enterprise_architecture_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset planview_enterprise_architecture_data The duckdb destination used duckdb:/planview_enterprise_architecture.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline planview_enterprise_architecture_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads public-api/v1/work and v2.0/services/data/query from the Planview Enterprise Architecture API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def planview_enterprise_architecture_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{your_account}.pvcloud.com/{your_server}/public-api/v1", "auth": {"type": "bearer", "token": access_token}, }, "resources": [ {"name": "resources", "endpoint": {"path": "resources", "data_selector": "data"}}, {"name": "applications", "endpoint": {"path": "applications", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="planview_enterprise_architecture_pipeline", destination="duckdb", dataset_name="planview_enterprise_architecture_data", ) load_info = pipeline.run(planview_enterprise_architecture_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("planview_enterprise_architecture_pipeline").dataset() sessions_df = data.resources.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM planview_enterprise_architecture_data.resources LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("planview_enterprise_architecture_pipeline").dataset() data.resources.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Planview Enterprise Architecture data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI harness:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-platform— Deploy, schedule, and monitor your pipeline in production.
dlthub ai toolkit data-exploration install dlthub ai toolkit dlthub-platform install
Was this page helpful?
Community Hub
Need more dlt context for Planview Enterprise Architecture?
Request dlt skills, commands, AGENT.md files, and AI-native context.