reports

Preview the first page of the project Gantt PDF

The export dialog's preview: the same PDF gantt.pdf would send for the same query (same options, refusals and renderer), with its first page rasterized at low resolution. Inline and not cached. X-Gantt-Pdf-Pages carries the page count of the full PDF. Its own rate limit of 240 previews per user per hour, apart from the exports. Answers 501 PREVIEW_UNAVAILABLE on a deployment without the rasterizer.

get/reports/project/{id}/gantt-preview.png

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/reports/project/{id}/gantt-preview.png
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

Project UUID

Query parameters

tokenstring required

JWT for authentication

pageSizestring

As gantt.pdf

orientationstring

As gantt.pdf

marginsstring

As gantt.pdf

scalestring

As gantt.pdf

fitstring

As gantt.pdf

tablestring

As gantt.pdf

fromstring

As gantt.pdf

tostring

As gantt.pdf

baselineIdstring

As gantt.pdf

showCriticalPathstring

As gantt.pdf

showDependenciesstring

As gantt.pdf

showBaselinestring

As gantt.pdf

hideCompletedstring

As gantt.pdf

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Response

PNG of page 1; X-Gantt-Pdf-Pages carries the full page count

Changes

No recorded changes to this operation across all 1 revision of this API.