Cancel a BUCKET file that is still CREATED, e.g. after a mistake: it becomes CANCELLED for good. Once its processing started a file cannot be cancelled (409), nor can a DEFAULT file (409) | Solvimon

{
  "object_type": "string",
  "id": "string",
  "reference": "string",
  "file_name": "string",
  "created_at": "string",
  "status": "CREATED",
  "type": "EVENTS",
  "name": "string",
  "description": "string",
  "customer_id": "string",
  "processing_type": "DEFAULT",
  "file_processing_settings_id": "string",
  "events": {
    "meter_id": "string",
    "meter_reference": "string",
    "override_ingest_timestamp": "2024-01-15T09:30:00Z"
  },
  "meter_data": {
    "meter_id": "string",
    "meter_reference": "string",
    "override_ingest_timestamp": "2024-01-15T09:30:00Z"
  },
  "content_type": "string",
  "column_headers": [
    "string"
  ],
  "number_of_lines": 1,
  "message": "string",
  "download_settings": {
    "external_location": "string"
  },
  "source": "DEFAULT",
  "line_counts": {
    "processed": 1,
    "done": 1,
    "not_matched": 1,
    "duplicate": 1,
    "error": 1
  },
  "bucket_files": {
    "original": {
      "created_at": "string",
      "file_name": "string",
      "expires_at": "string"
    },
    "ack": {
      "created_at": "string",
      "file_name": "string",
      "expires_at": "string"
    },
    "result": {
      "created_at": "string",
      "file_name": "string",
      "expires_at": "string"
    }
  },
  "upload": {
    "method": "string",
    "url": "string",
    "headers": {},
    "expire_at": "string"
  }
}

Requires the FILE.METER_DATA.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

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 for which the action is posted.

Response

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

404

Not Found Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors