Event APIFiles

Create a file

Requires the FILE.METER_DATA.CREATE 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

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
referencestringRequiredformat: "^\S+$"0-256 characters
file_namestringRequiredformat: "^[a-zA-Z0-9!#$%&-_.*\s]*$"0-256 characters
typeenumRequired
processing_typeenum or nullRequired
contentstringRequired
The content of the file, BASE64 encoded
statusenumOptional
namestring or nullOptionalformat: "^.*$"0-256 characters
descriptionstring or nullOptionalformat: "^.*$"0-256 characters
customer_idstring or nullOptional
file_processing_settings_idstring or nullOptional
meter_dataobjectOptional
content_typestringOptional
number_of_lineslongOptional
download_settingsobjectOptional

Response

Created
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
referencestringOptionalformat: "^\S+$"0-256 characters
file_namestringOptionalformat: "^[a-zA-Z0-9!#$%&-_.*\s]*$"0-256 characters
created_atstring or nullOptionalRead-only
statusenumOptional
typeenumOptional
namestring or nullOptionalformat: "^.*$"0-256 characters
descriptionstring or nullOptionalformat: "^.*$"0-256 characters
customer_idstring or nullOptional
processing_typeenum or nullOptional
file_processing_settings_idstring or nullOptional
meter_dataobjectOptional
content_typestringOptional
column_headerslist of strings or nullOptionalRead-only
number_of_lineslongOptional
messagestring or nullOptionalRead-only
download_settingsobjectOptional

Errors

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