GET /api/v202406/esachannel/{esaChannelId}/version/{versionId}/udf/{udfId}/download

Downloads the file attached to an ESA channel version's file-type custom field

DownloadEsaChannelVersionCustomFieldFileV202406 Permissions: Meters (View)
Use this endpoint to retrieve a file that was previously uploaded to a user-defined field (UDF) on an ESA channel version. The version’s custom field values, including the file name, are returned in the Udfs list of GET /api/v202406/esachannel/{esaChannelId}/version/{versionId}. Returns 404 if the version does not belong to the channel, the custom field does not exist, or no file was uploaded for this version.

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
esaChannelId Unique numeric identifier of the ESA channel the version belongs to integer (int32) Required
versionId Unique numeric identifier of the ESA channel version the file belongs to 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.