Update file processing settings | Solvimon

curl -X PATCH https://test.api.solvimon.com/v1/file-processing-settings/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "meter_data_2024_06",
  "type": "METER_DATA"
}'

{
  "reference": "meter_data_2024_06",
  "type": "METER_DATA",
  "object_type": "file_processing_setting",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "meter_data": {
    "mapping_column": "meter_id",
    "mappings": [
      {
        "column_values": [
          "electricity",
          "water"
        ],
        "meter_reference_mapping": {
          "column": "meter_serial",
          "custom_field": "serial_number",
          "id": "ref-12345",
          "reference": "meter_ref_001"
        },
        "ingest_reference_mapping": {
          "column": "ingest_id",
          "prefix": {
            "column": "region_code",
            "custom_field": "region_prefix"
          }
        },
        "meter_property_mappings": [
          {
            "column": "property_code",
            "id": "prop-67890",
            "reference": "property_ref_01",
            "default_value": {
              "absent_column": "N/A",
              "empty_field": "unknown"
            }
          }
        ],
        "meter_value_mappings": [
          {
            "id": "val-54321",
            "reference": "value_ref_01",
            "column": {
              "number": "reading_value",
              "amount": {
                "quantity": "consumption_kwh",
                "currency": "USD"
              }
            },
            "default_value": {
              "number": {
                "absent_column": "0",
                "empty_field": "0"
              },
              "amount": {
                "quantity": {
                  "absent_column": "0",
                  "empty_field": "0"
                },
                "currency": {
                  "absent_column": "USD",
                  "empty_field": "USD"
                }
              }
            }
          }
        ]
      }
    ],
    "customer_reference_mapping": {
      "column": "customer_id",
      "custom_field": "account_number"
    }
  },
  "bucket_location": "s3://company-data-bucket/meter-readings/2024/06/",
  "download_settings": {
    "authentication": {
      "api_key": {
        "header": "X-API-KEY",
        "value": "a1b2c3d4e5f67890abcdef1234567890"
      },
      "client_credentials": {
        "client_id": "client_987654321",
        "client_secret": "secretKey1234567890"
      },
      "username_password": {
        "username": "data_ingest_user",
        "password": "StrongP@ssw0rd!"
      }
    }
  },
  "included_customers": [
    {
      "id": "cust-001",
      "reference": "customer_ref_001",
      "custom_field_value": "premium_account"
    }
  ],
  "excluded_customers": [
    {
      "id": "cust-999",
      "reference": "customer_ref_999",
      "custom_field_value": "inactive_account"
    }
  ]
}

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 to be requested.

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

typeenumRequired

Allowed values:

meter_dataobjectOptional

bucket_locationstring or nullOptional

download_settingsobjectOptional

included_customerslist of objects or nullOptional

excluded_customerslist of objects or nullOptional

Response

referencestringformat: "^\S+$"0-256 characters

typeenum

Allowed values:

object_typestring or nullRead-only

idstring or nullRead-only

meter_dataobject

bucket_locationstring or null

download_settingsobject

included_customerslist of objects or null

excluded_customerslist of objects or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors