Document Platform

Start the preflight scan of a ZIP uploaded into a project

Registers an archive uploaded with the project-archive target and scans its contents before anything is imported. Pass checklistItemId when the archive was dropped on one requirement: every extracted document is then linked to it. Without it the documents are matched to the uploader's requirements after the import.

post/customers/{customerId}/projects/{projectId}/archive-preflight/

Request

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

Path parameters

customerIdstring uuid required
projectIdstring required

Request body

documentIdstring uuid required
objectKeystring required
checklistItemIdstring
filenamestring

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.