Document Platform

Start a ZIP upload preflight scan

Scan an uploaded archive's contents before any documents are created or counted against the document cap. Returns the preflight run record.

post/customers/{customerId}/buildings/{buildingId}/archive-preflight

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/buildings/{buildingId}/archive-preflight
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required
buildingIdstring uuid required

Request body

documentIdstring uuid required
objectKeystring required

Response

Default Response

preflightIdstring required
buildingIdstring required
customerIdstring required
documentIdstring required
objectKeystring required
status'scanning' | 'ready' | 'awaiting_approval' | 'approved' | 'importing' | 'completed' | 'cancelling' | 'cancelled' | 'failed' required
startedAtstring required
completedAtstring
errorstring
projectIdstring
checklistItemIdstring
subcontractorIdstring
assignedOnlyboolean
uploadedBystring
filenamestring

Changes

No recorded changes to this operation across all 1 revision of this API.