Download the project Gantt chart as a PDF
Renders the Gantt server-side as a vector PDF: a task table (WBS number, name, start, finish, and with table=full also duration, percent and owner), the timeline with weekend and holiday shading from the project calendar, status-coloured bars with progress, summary brackets, milestone diamonds, finish-to-start arrows, an optional baseline overlay and the critical path in red. Available on every plan with the same visibility rule as the Excel and MSPDI exports. Refuses more than 20,000 tasks (422 FILE_TOO_COMPLEX) and a layout over 600 pages (422 PDF_TOO_LARGE). Rate limited to 30 exports per user per hour (429).
Request
- Base URL: https://api.onplana.com/api
- URL: https://api.onplana.com/api/reports/project/{id}/gantt.pdf
- Auth: one of:
- HTTP bearer
- API key in header Authorization
Path parameters
Project UUID
Query parameters
JWT for authentication
A4 (default), A3, A2, A1, A0, LETTER or TABLOID
landscape (default) or portrait
narrow (0.25in), normal (default, 0.5in) or wide (0.75in)
auto (default), day, week or month
width (default: the whole range on one page width) or tiled (fixed legible density across horizontal pages)
compact (default) or full
YYYY-MM-DD, start of the printed range (default: earliest task)
YYYY-MM-DD, end of the printed range (default: latest task)
A saved baseline to overlay as grey bars
1 (default) or 0
1 (default) or 0
1 (default) or 0; only applies when baselineId is given
0 (default) or 1; drops DONE tasks and their subtasks
Headers
UUID of the active organization. Sets org context for all scoped operations.
Response
PDF file download; X-Gantt-Pdf-Pages carries the page count
Changes
No recorded changes to this operation across all 1 revision of this API.