Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Inspections

Export inspection to PDF or Word

post/inspection/v1/export

Request body

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
timezonestring

Sets the timezone for bulk exporting file name

regenerateboolean

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

langstring

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

Example request

{
  "export_data": [
    {
      "inspection_id": "9961f8ef-fa73-4e66-bd79-17138f83a5b8",
      "lang": "en-US",
      "preference_id": "5e3fe9e1-8b3f-41d2-8e2e-1b6172068bb2",
      "pages": [
        "3990d1f7-d9c0-48d8-8e3f-50ba6f164b0f",
        "45ecc281-0cbf-480d-a66a-a00aae195fd5"
      ],
      "media_layout": {
        "size": "MEDIA_SIZE_SMALL",
        "resolution": "MEDIA_RESOLUTION_LOW"
      }
    }
  ]
}

Response

A successful response.

urlstring

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'