Export a PDF of an inspection

Works exactly like GET /inspections/{inspectionId}/export, but accepts a larger payload, because it's sent in the body instead of the query string.

Path Params
integer
required

The ID of the existing inspection request.

Body Params

The request body for POST /inspections/{inspectionId}/export.

boolean
Defaults to false

Whether to queue the PDF for asynchronous export instead of exporting it synchronously, in the request/response cycle.

If false (or unspecified), the PDF is exported synchronously and returned in the response. This is the default for backward compatibility, but it's deprecated in favor of exporting asynchronously.

If true, the PDF is queued for asynchronous export and an Operation is returned to track its progress. This is recommended.

captureLocationMaps
array of strings
Defaults to outside,within,no_location

Which capture location maps to render in the Image Details section. Omit it to render a map for every capture (the default). Provide a subset to limit it, or an empty array to render no maps.

  • outside: captures taken outside the expected address
  • within: captures taken within the expected address
  • no_location: captures with no expected address on the inspection
captureLocationMaps
Allowed:
exclude
array of strings
Defaults to []

Sections to exclude that are included by default. Omit it to exclude no sections.

It accepts the canonical section IDs and the legacy tokens questions (for Inspection Items), thumbnails (a no-op), imageDetails and timeline.

exclude
filter
object

The photos and videos to include in the PDF. When it's specified, the PDF includes only the listed photos and videos. Omit it to include all of them, which is the default.

boolean
Defaults to true

Whether to use high-resolution images in the exported PDF.

include
array of strings
Defaults to []

Additional sections to include that aren't included by default. Omit it to include no extra sections.

It accepts the legacy inspectionNote alias and the canonical section IDs. The only opt-in section is Inspection Notes. The other IDs are accepted for forward compatibility, and are no-ops when a section is already included.

include
boolean
Defaults to true

Whether to include items the customer never submitted (unanswered questions and captures with no upload) in the Inspection Items section. Set it to false to hide them.

string
Defaults to UTC

The IANA time zone name to use when displaying dates and times in the PDF. Defaults to UTC. Unrecognized names fall back to UTC.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf
application/json