Document Platform

Request import of a ZIP preflight selection

Record the uploader's chosen folders and run the batch cap gate. Returns the run: approved when the projected documents fit the remaining allowance, or awaiting_approval when they exceed it.

post/customers/{customerId}/buildings/{buildingId}/archive-preflight/{preflightId}/import-request

Request

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

Path parameters

customerIdstring uuid required
buildingIdstring uuid required
preflightIdstring uuid required

Request body

selectedFolderIdsstring[] 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.