External
Document Platform

Create a new document upload request

Generate a document ID and signed upload URL for uploading a new document to a building

put/building_owners/{buildingOwnerId}/buildings/{buildingId}/documents/

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/building_owners/{buildingOwnerId}/buildings/{buildingId}/documents/
  • Auth: API key in header x-api-key

Path parameters

buildingOwnerIdstring required

ID of the building owner

buildingIdstring required

ID of the building

Request body

filenamestring required

Name of the file

originalCreatedAtstring date-time

Original creation date of the file

serialNumberstring

Serial number of the file

Response

Default Response

documentIdstring

ID of the created document

uploadUrlstring

URL to upload the document content

Changes

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