Event APIFiles

Get a file by its ID

Requires the FILE.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
referencestringformat: "^\S+$"0-256 characters
file_namestringformat: "^[a-zA-Z0-9!#$%&-_.*\s]*$"0-256 characters
statusenum
typeenum
Allowed values:
content_typestring
number_of_lineslong
object_typestring or nullRead-only
idstring or nullRead-only
created_atstring or nullRead-only
namestring or nullformat: "^.*$"0-256 characters
descriptionstring or nullformat: "^.*$"0-256 characters
customer_idstring or null
processing_typeenum or null
Allowed values:
file_processing_settings_idstring or null
meter_dataobject
column_headerslist of strings or nullRead-only
messagestring or nullRead-only
download_settingsobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error