External
Document Platform

Update document metadata

Update metadata for a specific document such as filename, creation date, or building category

patch/v1/building_owners/{buildingOwnerId}/buildings/{buildingId}/documents/{documentId}/

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/v1/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

Request body

filenamestring

Name of the file

originalCreatedAtstring date-time

Original creation date of the file

serialNumberstring

Serial number of the file

buildingCategorystring

Category of the building

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

Changes

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