Downloads a file stored in a file-type custom field for an energy project
Use this endpoint to retrieve the binary file content of a file-type UDF.
Returns the file as a downloadable attachment. Requires Buildings and Organizations View permission.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| energyProjectId | Unique numeric identifier of the energy project | integer (int32) | Required |
| udfId | Unique numeric identifier of the file-type custom field | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
404
Not Found
The requested resource was not found. Verify the ID or path is correct.