Document Platform

Get system details

Retrieve details of a specific building system

get/customers/{customerId}/buildings/{buildingId}/systems/{systemId}

Request

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

Path parameters

customerIdstring uuid required
buildingIdstring uuid required
systemIdstring uuid required

Response

Default Response

idstring uuid required
customerIdstring uuid required
buildingIdstring uuid required
categoryCodestring required
serialNumberstring nullable required
fullCodestring required
namestring nullable
descriptionstring nullable
locationstring nullable
famacSystemIdstring nullable
famacLastSyncAtstring nullable
documentCountinteger
isDeletedboolean
isDeletingboolean
deletedAtstring nullable
deletedBystring nullable
createdBystring
createdByEmailstring
updatedBystring
updatedByEmailstring
writeAccessCustomerstring nullable
readAccessCustomerstring nullable
writeAccessBuildingstring nullable
readAccessBuildingstring nullable
categoryNamestring
categoryNameEnstring
taskCountinteger
drawingCountinteger
unitCountinteger

Changes

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