--- title: "Export inspection to PDF or Word" method: POST path: "/inspection/v1/export" tags: ["Inspections"] --- # Export inspection to PDF or Word `POST /inspection/v1/export` ## Request body - S12ReportsV1StartInspectionExportRequest - `export_data` S12ReportsV1StartInspectionExportRequestExportData[], required — List of report configurations - `inspection_id` string, required — The ID of the inspection, this can be an s12ID or a UUID. - `lang` string — Sets the language for the document using language code from ISO-639 format. This is backward compatible with v2 request coming through thepub. Please use the lang property in the root level instead. - `preference_id` string — Sets the requested preference - `filters` S12ReportsV1Filter - `show_actions` boolean — Show/hide actions from the inspection report - `show_failed_items` boolean — Show/hide failed items - `show_scores` boolean — Show/hide all scoring - `show_inspection` boolean — Show/hide the inspection result - `show_instructions` boolean — Show/hide information/instruction fields - `show_unanswered` boolean — Show/hide unanswered questions - `show_toc` boolean — Show/hide table of content in exported file - `show_high_quality_photo` boolean — Show high/normal quality photo in exported file @deprecated: use media_layout on the upper level instead - `show_disclaimer` boolean — Show/hide the report disclaimer - `show_media_summary` boolean — Show media summary at the end of the report - `show_footer` boolean — Show/hide footer - `show_footer_inspection_title` boolean — Show/hide just the inspection title in footer - `show_footer_custom_text` boolean — Show/hide just the custom text in footer - `enable_pdf_private_link` boolean — Toggle the private pdf link feature - `show_page_break` boolean — Show/hide page breaks for each section - `hide_failed_items_in_summary` boolean — Show/hide failed items in report summary - `hide_actions_in_summary` boolean — Show/hide actions in report summary - `hide_checked_questions` boolean — Show/hide checked questions in report summary - `hide_unchecked_questions` boolean — Show/hide unchecked questions in report summary - `show_ai_summary` boolean — Show/hide AI generated summary in report summary - `show_tables` boolean — Show/hide any tables in the report - `pages` string[] — @deprecated: Prefer using the preference_override field instead Sets the pages need to be hid for the generated document - `media_layout` S12ReportsV1MediaLayout - `size` 'MEDIA_SIZE_UNSPECIFIED' | 'MEDIA_SIZE_SMALL' | 'MEDIA_SIZE_MEDIUM' | 'MEDIA_SIZE_LARGE' — - MEDIA_SIZE_SMALL: Thumbnails: 6 per row, Appendix: 4 images per page - MEDIA_SIZE_MEDIUM: Thumbnails: 3 per row; Appendix: 2 images per page - MEDIA_SIZE_LARGE: Thumbnails: 2 per row; Appendix: 1 image per page - `resolution` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_HIGH' — - MEDIA_RESOLUTION_LOW: Render images in low resolution (smaller file size) - MEDIA_RESOLUTION_HIGH: Render images in high resolution (larger file size) - `preference_override` S12ReportsV1Preference - `id` string — The preference id - `creator_id` string — The user who created the preference - `organisation_id` string — The org id of the user who created this preference - `filter` S12ReportsV1Filter - `show_actions` boolean — Show/hide actions from the inspection report - `show_failed_items` boolean — Show/hide failed items - `show_scores` boolean — Show/hide all scoring - `show_inspection` boolean — Show/hide the inspection result - `show_instructions` boolean — Show/hide information/instruction fields - `show_unanswered` boolean — Show/hide unanswered questions - `show_toc` boolean — Show/hide table of content in exported file - `show_high_quality_photo` boolean — Show high/normal quality photo in exported file @deprecated: use media_layout on the upper level instead - `show_disclaimer` boolean — Show/hide the report disclaimer - `show_media_summary` boolean — Show media summary at the end of the report - `show_footer` boolean — Show/hide footer - `show_footer_inspection_title` boolean — Show/hide just the inspection title in footer - `show_footer_custom_text` boolean — Show/hide just the custom text in footer - `enable_pdf_private_link` boolean — Toggle the private pdf link feature - `show_page_break` boolean — Show/hide page breaks for each section - `hide_failed_items_in_summary` boolean — Show/hide failed items in report summary - `hide_actions_in_summary` boolean — Show/hide actions in report summary - `hide_checked_questions` boolean — Show/hide checked questions in report summary - `hide_unchecked_questions` boolean — Show/hide unchecked questions in report summary - `show_ai_summary` boolean — Show/hide AI generated summary in report summary - `show_tables` boolean — Show/hide any tables in the report - `created_at` string, date-time — Date/time this preference was created - `modified_at` string, date-time — Date/time this preference was modified - `label` string — The label/title of this preference - `is_default` boolean — Is this a default preference for a template - `logo` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `disclaimer` string — Disclaimer message - `is_global` boolean — Is this preference a global preference? - `template_id` string — The template id where this preference can be associated with - `pages` string[] — List of page IDs to be filtered - `email_subject` string — Email template to prefill with when sending PDF - `email_body` string - `contacts` S12ReportsV1PreferenceContact[] — Contacts to prefill email with - `contact_type` 'UNKNOWN_CONTACT_TYPE' | 'EXTERNAL' | 'USER' | 'GROUP' - `delivery_type` 'UNKNOWN_DELIVERY_TYPE' | 'TO' | 'CC' | 'BCC' - `value` string — Email address (or userId/groupId in the future) - `footer_text` string — Footer message - `media_layout` S12ReportsV1MediaLayout - `size` 'MEDIA_SIZE_UNSPECIFIED' | 'MEDIA_SIZE_SMALL' | 'MEDIA_SIZE_MEDIUM' | 'MEDIA_SIZE_LARGE' — - MEDIA_SIZE_SMALL: Thumbnails: 6 per row, Appendix: 4 images per page - MEDIA_SIZE_MEDIUM: Thumbnails: 3 per row; Appendix: 2 images per page - MEDIA_SIZE_LARGE: Thumbnails: 2 per row; Appendix: 1 image per page - `resolution` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_HIGH' — - MEDIA_RESOLUTION_LOW: Render images in low resolution (smaller file size) - MEDIA_RESOLUTION_HIGH: Render images in high resolution (larger file size) - `cover_page` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `inspection_items` string[] — List of report configurations - `thumbnail_size` 'MEDIA_SIZE_UNSPECIFIED' | 'MEDIA_SIZE_SMALL' | 'MEDIA_SIZE_MEDIUM' | 'MEDIA_SIZE_LARGE' — - MEDIA_SIZE_SMALL: Thumbnails: 6 per row, Appendix: 4 images per page - MEDIA_SIZE_MEDIUM: Thumbnails: 3 per row; Appendix: 2 images per page - MEDIA_SIZE_LARGE: Thumbnails: 2 per row; Appendix: 1 image per page - `email_auto_send` boolean — To specify whether emails are automatically sent for this template or not. - `page_size` 'PAGE_SIZE_UNSPECIFIED' | 'PAGE_SIZE_A4' | 'PAGE_SIZE_US_LETTER' - `blueprint_id` string — Routing key selecting the report blueprint/layout to render. Unset means render with the existing default blueprint. - `report_styles` S12ReportsV1ReportStyle — ReportStyle represents the styling customisation applied to a report, such as font family and branding colour. - `font_family` 'FONT_FAMILY_UNSPECIFIED' | 'FONT_FAMILY_NOTO_SANS' | 'FONT_FAMILY_INTER' | 'FONT_FAMILY_IBM_PLEX_SERIF' | 'FONT_FAMILY_ARIAL' | 'FONT_FAMILY_VERDANA' | 'FONT_FAMILY_TAHOMA' — - FONT_FAMILY_NOTO_SANS: Noto Sans (current default in reports) - `brand_color` string — Hex representation of the report's branding colour, e.g. "#FFFFFF" - `type` 'DOCUMENT_TYPE_UNSPECIFIED' | 'DOCUMENT_TYPE_PDF' | 'DOCUMENT_TYPE_WORD' | 'DOCUMENT_TYPE_MEDIA' | 'DOCUMENT_TYPE_EXCEL' | 'DOCUMENT_TYPE_CSV_V3' | 'DOCUMENT_TYPE_JSON' | 'DOCUMENT_TYPE_CSV' | 'DOCUMENT_TYPE_CSV_MEDIA' | 'DOCUMENT_TYPE_CSV_EXCEL', required - `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` S12ReportsV1StartInspectionExportRequestInspectionFilter - `search_text` string — text to search against. - `template_ids` string[] — The ID of the template to be filter with, this can be an s12ID or a UUID - `template_folders` string[] — template folder ids to filter by - `groups` string[] — the role_id to be filter by - `sites` string[] — locations (sites) to filter by - `from_date` string, date-time — earlier date in conducted date range to filter by - `to_date` string, date-time — later date in conducted date range to filter by - `from_date_completed` string, date-time — earlier date in completed date range to filter by - `to_date_completed` string, date-time — later date in completed date range to filter by - `asset_ids` string[] — asset ids to filter by - `owned` boolean — filter by inspections owned by user - `shared` boolean — filter by inspections shared with user - `is_archived` boolean — filter by archived - `completed` boolean — Optional. When set to true, inspections that are completed will be included. When set to false, inspections that are not-completed will be included. If unset, this property is ignored The fields completed, exclude_pending_approvals and inspection_approval_state are used to query the inspection state They are set like this for historical reasons in inspections. - `export_settings` S12ReportsV1StartInspectionExportRequestTabularExportSettings - `show_empty_notes` boolean — This setting determines whether to include a separate column for unpopulated notes field for each inspection question - `show_empty_timestamps` boolean — This setting determines whether to include a separate column for empty timestamp from each signature / temperature type question - `show_full_site_hierarchy` boolean — This setting determines whether to include a separate column for all non-defined site hierarchy level - `show_unanswered_logic_questions` boolean — This setting determines whether to include unanswered logic questions for reports - `show_inactive_questions` boolean — This setting determines whether to include inactive questions (such as skipped questions) in tabular export ## Response `200` A successful response. - S12ReportsV1StartInspectionExportResponse - `url` string — The S3 bucket url for the generated export file, the url will only be populated when the status is 'DONE' - `status` 'STATUS_UNSPECIFIED' | 'STATUS_IN_PROGRESS' | 'STATUS_FAILED' | 'STATUS_DONE' - `version` 'VERSION_UNSPECIFIED' | 'VERSION_1' | 'VERSION_2' | 'VERSION_3' - `info` S12ReportsV1StartInspectionExportResponseInfo[] — Any additional info that feedback to the calling service - `subject` string — The code for a particular subject - `details` string — Any additional details for the particular subject ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/safetyculture/apis/safetyculture-api.md) · [All operations](https://skmtc.net/safetyculture/apis/safetyculture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safetyculture/safetyculture-api/revisions/5be91df61ded/schema)