Place
GET
15 endpoints
/api/v202105/place/{placeId}/udf/{udfId}/download
DownloadPlaceCustomFieldFileV202105
Download file for a place custom field
/api/v3/place/{placeId}/project
GetEnergyProjectsForPlaceV3
Retrieves all Energy Projects for a particular place by placeId. For organizations it will be the rollup of its children's energy projects
/api/v3/place/{placeId}/energyStar/hierarchy
GetEnergyStarPlaceHierarchyV3
Get this place's ENERGY STAR child places
/api/v3/place/{placeId}/energyStar/link
GetEnergyStarPlaceLinkV3
Get the ENERGY STAR linking information for this place and its meters.
PmPropertyId and PmMeterId will be null if no link yet exists.
/api/v3/place/{placeId}/energyStar/metrics
GetEnergyStarPlaceMetricsV3
Get the ENERGY STAR metrics for a place.
/api/v3/place/{placeId}/energyStar
GetEnergyStarPlaceV3
Get the ENERGY STAR info for a place.
/api/v3/place/{placeId}/group
GetPlaceGroupsV3
Retrieves all Place Groups for a particular place by placeId
/api/v3/place/{placeId}/size
GetPlaceSizesV3
Retrieves all place size records for a particular place
/api/v3/place/{placeId}/size/{placeSizeId}
GetPlaceSizeV3
Retrieves a place size record for a particular place
/api/v3/place/udf
GetPlacesUdfsV3
Retrieves all user defined fields / custom fields for all places
/api/v3/place
GetPlacesV3
Retrieves all places
/api/v3/place/placetype
GetPlaceTypesV3
Retrieves all place types
/api/v3/place/placetype/{placeTypeId}
GetPlaceTypeV3
Retrieves one place type
/api/v3/place/{placeId}/udf
GetPlaceUdfsV3
Retrieves all user defined fields / custom fields for a particular place
/api/v3/place/{placeId}
GetPlaceV3
Retrieves one place
POST
3 endpoints
/api/v3/place/{placeId}/size
CreatePlaceSizeV3
Creates a place size version
If a preceding place size version exists, the preceding record's end date will be changed to match the created record's begin date
If a succeeding place size version exists the created records end date will match the succeeding version's begin date
/api/v3/place/placetype
CreatePlaceTypeV3
Create a place type
/api/v3/place
CreatePlaceV3
Creates a place
PUT
10 endpoints
/api/v3/place/{placeId}/energyStar/link
EditEnergyStarPlaceLinkV3
Edit the ENERGY STAR linking information for this place and its meters.
Set PmPropertyId/PmMeterId to null to unlink a property/meter.
Set PmMeterId to -1 to auto-create a new meter.
/api/v3/place/{placeId}/group
EditPlaceGroupMembershipV3
Edits a place's group memberships.
Note that all groups a place should belong to must be passed in. Passing in one group means that the place will belong to one group only,
even if it previously belonged to several.
Only manual groups assignments can be changed; auto groups are unaffected.
/api/v3/place/{placeId}/size
EditPlaceSizeListV3
API endpoint which takes care of Create, Edit and Delete of new place sizes in bulk
/api/v3/place/placetype/{placeTypeId}
EditPlaceTypeV3
Edit a current place type
/api/v3/place/{placeId}/udf
EditPlaceUDFsV3
Edits user defined field / custom field values for a particular place
/api/v3/place/{placeId}
EditPlaceV3
Edits a place
/api/v202302/place/{placeId}/watticsSite
EditWatticsSiteLinkV202302
Edit SmartAnalytics (Wattics) data on a place
/api/v3/parentPlace/{parentPlaceId}/place
MovePlaceV3
Move list of places to be under parentPlaceId
/api/v202110/place/energyStar/unlink
UnlinkPlacesAndChildMetersFromEnergyStarV202110
Unlink a list of places and their child meters from ENERGY STAR
/api/v202110/place/energyStar/submissionType
UpdateEnergyStarSubmissionTypeV202110
Update a list of places to be submitted to ENERGY STAR manually or automatically
DELETE
3 endpoints
/api/v3/place/{placeId}/size/{placeSizeId}
DeletePlaceSizeV3
Delete a place size version
The preceding version's end date will be shifted to the deleted record's end date to prevent any gaps
/api/v3/place/placetype/{placeTypeId}
DeletePlaceTypeV3
Deletes the place type
/api/v3/place/{placeId}
DeletePlaceV3
Deletes a place