Skip to navigation
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
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
referencestringOptionalformat: "^\S+$"0-256 characters
file_namestringOptionalformat: "^[a-zA-Z0-9!#$%&-_.*\s]*$"0-256 characters
The name of the uploaded file. Required for a DEFAULT file, cannot be set on a BUCKET file
created_atstring or nullOptionalRead-only
statusenumOptional
typeenumOptional

EVENTS. METER_DATA is deprecated: still accepted and handled the same as EVENTS, but use EVENTS

Allowed values:
namestring or nullOptionalformat: "^.*$"0-256 characters
descriptionstring or nullOptionalformat: "^.*$"0-256 characters
customer_idstring or nullOptional
processing_typeenum or nullOptional
DEFAULT when left out. A BUCKET file only takes DEFAULT
Allowed values:
file_processing_settings_idstring or nullOptional
eventsobjectOptional

For type EVENTS: the meter and the ingest timestamp of its lines

meter_dataobjectOptional

As events, for the deprecated type METER_DATA

content_typestringOptional
column_headerslist of strings or nullOptionalRead-only
number_of_lineslongOptional
messagestring or nullOptionalRead-only
download_settingsobjectOptional
sourceenumOptional

Where the content comes from: DEFAULT (in content) or BUCKET (uploaded to the upload url). Cannot be changed

Allowed values:
line_countsobject or nullOptional
bucket_filesobject or nullOptional
uploadobject or nullOptional
Only in the response to creating a BUCKET file

Errors

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