API Tutorials for Ticket Report Endpoints

Overview

In this article, you’ll find tutorials about how to generate ticket reports through the PlanRadar API.

Find other tutorials in Open API Overview > API Tutorials.

Export single ticket as PDF file

The Single Ticket Export endpoint allows you to export a single ticket as a PDF file from PlanRadar.

Endpoint

GET /api/v2/{customer_id}/projects/{project_id}/tickets/{ticket_uuid}/single_ticket_export

How it works

• Exports one ticket as PDF file.

• Returns binary PDF data directly unless asynchronous mode is enabled (see below) or the ticket has more than 10 attachments

Optional query parameters

async

If set to true, the endpoint returns a Job ID instead of binary PDF data.
The Job ID can subsequently be used to check the status (see Check report status below) and download the file once it is finished.

template_id

If you want to generate a report using a specific report template, add this parameter and set its value to the ID of the template you want to use (for more information about the template ID, please read Core API Concepts).

Export multiple tickets as PDF file

The Multi Ticket Export (PDF) endpoint allows you to export multiple tickets as a PDF file from PlanRadar.

Endpoint

POST /api/v1/{customer_id}/projects/{project_id}/tickets/export/pdf

Payload

To determine which tickets to export, pass their UUIDs in the request payload.
Below is an example payload structure containing two UUIDs:

{
  "filter": {
    "uuid": [
      "c287280d-4108-4278-8657-bb93efe638e6",
      "47be734f-4f23-438d-b3ae-591fc2c28fcc"
    ]
  },
  "replacement-tokens": {}
}

How it works

• Exports multiple tickets as a PDF file

• Returns a Job ID

• The Job ID can subsequently be used to check the status (for more information, please read Check report status) and download the file once it is finished

Optional query parameters

template_id

For more information, please check the respective section under Export single ticket.

apply_filter

If you want to use an existing filter in PlanRadar to determine the ticket selection, you can use this parameter and pass the ID of the filter (for more information about the filter ID, please read Core API Concepts).

Export tickets as Excel file

The Multi Ticket Export (Excel) endpoint allows you to export multiple tickets as an Excel file from PlanRadar.

Endpoint

POST /api/v1/{customer_id}/projects/{project_id}/tickets/export/xls

Payload

To determine which tickets to export, pass their UUIDs in the request payload.
Below is an example payload structure containing two UUIDs:

{
  "filter": {
    "uuid": [
      "c287280d-4108-4278-8657-bb93efe638e6",
      "47be734f-4f23-438d-b3ae-591fc2c28fcc"
    ]
  }
}

How it works

• Exports multiple tickets as an Excel file

• Returns a Job ID unless the report includes 100 or fewer tickets and the template has at least one photo (In that case, the file is returned directly)

• The Job ID can subsequently be used to check the status (see Check report status below) and download the file once it is finished

Optional query parameters

async

For more information, please check the respective section under Export single ticket.

template_id

For more information, please check the respective section under Export single ticket.

apply_filter

For more information, please check the respective section under Export multi tickets as PDF.

Check report status

The Check report status endpoint allows you to check for the status of a report that returned a job ID.

Endpoint

GET /api/{customer_id}/check_if_finished/{export_uuid}

How it works

• Returns {} as long as the report generation is in progress

• Returns a download link as soon as the report generation is finished

Example response

{
  "id": 10031794,
  "project_id": 1433123,
  "name": "Report_Projekt A_Standardbericht_01_01_2025_08_00_00.pdf",
  "author_id": 2063843,
  "created_on": "2025-01-01T08:09:49.905Z",
  "uuid": "40ef8d9d82cdf29440bf418ad2e43d85578c8855a2c99db55c8760664bf8793c",
  "export_type": "pdf",
  "updated_on": "2025-01-01T08:10:03.842Z",
  "checksum": "f9970b48f42f39aa542c0a9f47c8fb8d",
  "template_type": "DefectradarReportTemplate",
  "template_id": 1603634,
  "generate_download_url": "https://www.planradar.com/dr/project-export-download/40ef8d9d82cdf29440bf418ad2e43d85578c8855a2c99db55c8760664bf8793c"
}