Document Platform

Generate collection zip

Start generating a zip file for all documents in a collection

post/customers/{customerId}/buildings/{buildingId}/collections/{collectionId}/zip

Request

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

Path parameters

customerIdstring uuid required
buildingIdstring uuid required
collectionIdstring uuid required

Request body

groupBy'flat' | 'building_category' | 'folder_structure'
locale'en' | 'no' | 'fr'

Locale for folder names in the generated zip

projectIdstring uuid

Response

Zip generation started successfully

unknown required

Changes

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