Export inspection to PDF or Word

post

https://api.safetyculture.io/inspection/v1/export

🚧
This is a single synchronous request process that delays the HTTP request until a response is given, or a time-out of 60 seconds is reached. In cases where the time-out is reached, the caller can retry with the same set of data to continue the export process.
Ensure that the Inspections with media are fully synced before triggering a PDF or Word report export as this may cause issues (corrupt files) during export

📘
If the caller doesn't specify a valid timezone in the request, the dates and times on the reports will be set using the timezone of the associated SafetyCulture account.

The report endpoints allow you to retrieve an inspection report formatted as a PDF or Word (docx) document.

Body Params

export_data

array of objects

required

List of report configurations

export_data*

type

string

enum

required

Defaults to DOCUMENT_TYPE_UNSPECIFIED

The requested file type for the export

timezone

string

Sets the timezone for bulk exporting file name

regenerate

boolean

Indicate whether to by pass any caching and regenerate the report from the
latest data. This flag would only take effect for authorized user.

lang

string

Sets the language for the document using language code from ISO-639
format

inspection_filter

object

List of inspections filters that filters out which inspection to be included. This is optional and only be evaluate

export_settings

object

Sets of export settings that can apply to tabular export, eg Excel

Responses

200A successful response.

defaultAn unexpected error response.