External
Document Platform

Get a specific document

Retrieve a specific document from a building with its download URL

get/building_owners/{buildingOwnerId}/buildings/{buildingId}/documents/{documentId}/

Request

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

Path parameters

buildingOwnerIdstring required

ID of the building owner

buildingIdstring required

ID of the building

documentIdstring required

ID of the document

Response

Default Response

idstring
filenamestring
titlestring
originalPathstring
buildingCategorystring
disciplinestring
informationTypestring
informationTypesstring[]
isDrawingboolean
isSchemaDrawingboolean
serialNumberstring
sizeinteger
md5Checksumstring
corruptboolean
drawingDatestring date
originalCreatedAtstring date-time
createdAtstring date-time
updatedAtstring date-time
asBuiltboolean
urlstring
previewUrlstring nullable

Signed URL for a generated full PDF preview, or null when unavailable

Changes

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